Testdroid REST API

Testdroid REST API.

Schemes:

Summary

Tag: account-service

Account Service

Operation	Description
GET /api/v2/admin/device-time	Get entire device time history
POST /api/v2/services	Buy service
GET /api/v2/services/available	Get all available services for any user
GET /api/v2/users/{id}/device-time	Get device time history for user
GET /api/v2/users/{id}/device-time/reserved	Get reserved(status is WAITING or RUNNING) device time by user
GET /api/v2/users/{id}/device-time/used	Get used(status is SUCCEEDED or FAILED) device time by user
GET /api/v2/users/{id}/services/active	Get all active services for selected user
GET /api/v2/users/{id}/services/available	Get all available services for selected user
GET /api/v2/users/{id}/services/purchased	Get all purchased services by user
DELETE /api/v2/users/{id}/services/{serviceId}	Cancel service subscription
GET /api/v2/users/{userId}/account-services/{accountServiceId}/billing-period	Get billing information for billing period given by date
GET /api/v2/users/{userId}/billing-periods	Get users billing periods
GET /api/v2/users/{userId}/billing-periods/{billingPeriodId}	Get billing period
GET /api/v2/users/{userId}/billing-periods/{billingPeriodId}/receipt	Get purchased service receipt
POST /api/v2/users/{userId}/services	Buy service

Tag: account

Account

Operation	Description
GET /api/v2/users/{userId}/account	Get account

Tag: device-runs

Device Runs

Operation	Description
GET /api/v2/device-runs/{deviceRunId}	Get device run
GET /api/v2/device-runs/{deviceRunId}/cluster-logs	Get cluster build logs file
GET /api/v2/device-runs/{deviceRunId}/data-availability	Get device run data availability
GET /api/v2/device-runs/{deviceRunId}/fixtures.zip	Get device run fixtures.zip
GET /api/v2/device-runs/{deviceRunId}/junit.xml	Get the device run junit file
GET /api/v2/device-runs/{deviceRunId}/logs	Get device run logs file
GET /api/v2/device-runs/{deviceRunId}/performance	Get the device run performance file
GET /api/v2/device-runs/{deviceRunId}/result-data.zip	Get device run result data.zip
GET /api/v2/device-runs/{deviceRunId}/screenshots	Get the screenshot list of device run
GET /api/v2/device-runs/{deviceRunId}/screenshots/{screenshotId}	Get device run screenshot
GET /api/v2/device-runs/{deviceRunId}/states	Get the device run state list of device run
GET /api/v2/device-runs/{deviceRunId}/states/{stateId}	Get the device run state of device run
GET /api/v2/device-runs/{deviceRunId}/test-case-runs	Get device run steps
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs	Get the device run list of user test run
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}	Get device run
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/cluster-logs	Get cluster build logs file
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/data-availability	Get device run data availability
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/junit.xml	Get device run junit file
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/logs	Get device run logs file
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/performance	Get device run performance file
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/result-data.zip	Get device run result data.zip
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots	Get the screenshot list of device run
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots/{screenshotId}	Get screenshot
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states	Get the device run state list of user device run
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states/{stateId}	Get the device run state of device run
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/test-case-runs	Get device run steps
GET /api/v2/runs/{runId}/device-runs	Get the device run list of user test run
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}	Get device run
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/cluster-logs	Get cluster build logs file
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/data-availability	Get device run data availability
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/junit.xml	Get device run junit file
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/logs	Get device run logs file
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/performance	Get device run performance file
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/result-data.zip	Get device run result data.zip
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/screenshots	Get the screenshot list of device run
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/screenshots/{screenshotId}	Get screenshot
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/states	Get the device run state list of the device run
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/states/{stateId}	Get the device run state of device run
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/test-case-runs	Get device run steps
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs	Get the device run list of user test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}	Get the user device run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/cluster-logs	Get the user cluster build logs file
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/data-availability	Get device run data availability
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/junit.xml	Get the user device run junit file
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/logs	Get the user device run logs file
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/performance	Get the user device run performance file
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/result-data.zip	Get the user device run result data file
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots	Get the screenshot list of user device run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots/{screenshotId}	Get user screenshot
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states	Get the device run state list of the device run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states/{stateId}	Get the device run state of user device run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/test-case-runs	Get device run steps

Tag: jira

Jira

Operation	Description
GET /api/v2/jira/issues/issue-types	Get available jira issue types
GET /api/v2/jira/issues/priorities	Get available jira issue priorities
GET /api/v2/jira/issues/{issueKey}	Get issue with specified issueKey
POST /api/v2/jira/issues/{issueKey}	Update issue with specified issueKey
DELETE /api/v2/jira/issues/{issueKey}	Delete issue with specified issueKey
GET /api/v2/jira/projects	Get jira projects
GET /api/v2/jira/projects/{projectKey}	Get jira projects
GET /api/v2/jira/projects/{projectKey}/issues	Get jira issues by projectKey
POST /api/v2/jira/projects/{projectKey}/issues	Create jira issue in project with specified projectId
GET /api/v2/jira/server-info	Get jira server info and validate connection
GET /api/v2/users/{userId}/jira-account	Get jira account for user with userId
POST /api/v2/users/{userId}/jira-account	Create jira account for user with userId
GET /api/v2/users/{userId}/jira-account/{jiraAccountId}	Get jira account with specified jiraAccountId
POST /api/v2/users/{userId}/jira-account/{jiraAccountId}	Update jira account with specified jiraAccountId
DELETE /api/v2/users/{userId}/jira-account/{jiraAccountId}	Delete jira account with specified jiraAccountId
POST /api/v2/users/{userId}/jira-account/{jiraAccountId}/certificate	Update jira account certificate with specified jiraAccountId

Tag: file

File

Operation	Description
GET /api/v2/file-sets	Get the file set list
POST /api/v2/file-sets	Create file set
GET /api/v2/file-sets/{fileSetId}	Get the file set with specific ID
POST /api/v2/file-sets/{fileSetId}	Update the file set with specific ID
DELETE /api/v2/file-sets/{fileSetId}	Delete the file set with specific ID
GET /api/v2/file-sets/{fileSetId}/files	Get file list of file set
POST /api/v2/file-sets/{fileSetId}/files	Add file to file set
GET /api/v2/file-sets/{fileSetId}/files/{fileId}	Get user file with specific ID
POST /api/v2/file-sets/{fileSetId}/files/{fileId}	Update file name with specific id
DELETE /api/v2/file-sets/{fileSetId}/files/{fileId}	Delete file from file set
GET /api/v2/file-sets/{fileSetId}/files/{fileId}/file	Download file from file set
GET /api/v2/file-sets/{fileSetId}/files/{fileId}/icon	Download icon of file from file set
GET /api/v2/file-sets/{fileSetId}/files/{fileId}/tags	Get the file tags list
GET /api/v2/files	Get the file list
POST /api/v2/files	Upload file
GET /api/v2/files/{fileId}	Get user file with specific ID
POST /api/v2/files/{fileId}	Update file name with specific id
DELETE /api/v2/files/{fileId}	Delete file with specific ID
GET /api/v2/files/{fileId}/file	Download file
GET /api/v2/files/{fileId}/icon	Download icon of file
GET /api/v2/files/{fileId}/tags	Get the file tags list
GET /api/v2/projects/{projectId}/files	Get list of files in user project
GET /api/v2/projects/{projectId}/files.zip	Get zip file with artifacts of user project
GET /api/v2/projects/{projectId}/files/application	Get application file in user project
POST /api/v2/projects/{projectId}/files/application	Upload application file in user project
GET /api/v2/projects/{projectId}/files/data	Get data file in user project
POST /api/v2/projects/{projectId}/files/data	Upload data file in user project
GET /api/v2/projects/{projectId}/files/test	Get test file in user project
POST /api/v2/projects/{projectId}/files/test	Upload test file in user project
GET /api/v2/projects/{projectId}/runs/{runId}/files	Get list of files in user test run
GET /api/v2/projects/{projectId}/runs/{runId}/files.zip	Get zip file with artifacts of user test run
GET /api/v2/projects/{projectId}/runs/{runId}/files/application	Get application file in user project
GET /api/v2/projects/{projectId}/runs/{runId}/files/application/check-results	Get application file in user project
GET /api/v2/projects/{projectId}/runs/{runId}/files/data	Get data file in user project
GET /api/v2/projects/{projectId}/runs/{runId}/files/test	Get test file in user project
GET /api/v2/runs/{runId}/files	Get list of files in user test run
GET /api/v2/runs/{runId}/files.zip	Get zip file with artifacts of user test run
GET /api/v2/runs/{runId}/files/application	Get application file in user project
GET /api/v2/runs/{runId}/files/application/check-results	Get application file check results
GET /api/v2/runs/{runId}/files/data	Get data file in user project
GET /api/v2/runs/{runId}/files/test	Get test file in user project
GET /api/v2/users/{userId}/file-sets	Get the file set list of user with specific ID
POST /api/v2/users/{userId}/file-sets	Create file set for user
GET /api/v2/users/{userId}/file-sets/{fileSetId}	Get the file set of user with specific ID
POST /api/v2/users/{userId}/file-sets/{fileSetId}	Update the file set of user with specific ID
DELETE /api/v2/users/{userId}/file-sets/{fileSetId}	Delete the file set of user with specific ID
GET /api/v2/users/{userId}/file-sets/{fileSetId}/files	Get file list of user file set
POST /api/v2/users/{userId}/file-sets/{fileSetId}/files	Add file to file set
GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}	Get user file with specific ID
POST /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}	Update file name with specific id
DELETE /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}	Delete file from file set
GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}/file	Download file from file set
GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}/icon	Download icon of file from file set
GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}/tags	Get the file tags list
GET /api/v2/users/{userId}/files	Get the file list of user with specific ID
POST /api/v2/users/{userId}/files	Upload file for authenticated user
GET /api/v2/users/{userId}/files/{fileId}	Get user file with specific ID
POST /api/v2/users/{userId}/files/{fileId}	Update file name with specific id
DELETE /api/v2/users/{userId}/files/{fileId}	Delete file with specific ID
GET /api/v2/users/{userId}/files/{fileId}/file	Download file
GET /api/v2/users/{userId}/files/{fileId}/icon	Download icon of file
GET /api/v2/users/{userId}/files/{fileId}/tags	Get the file tags list
GET /api/v2/users/{userId}/projects/{projectId}/files	Get list of files in user project
GET /api/v2/users/{userId}/projects/{projectId}/files.zip	Get zip file with artifacts of user project
GET /api/v2/users/{userId}/projects/{projectId}/files/application	Get application file in user project
POST /api/v2/users/{userId}/projects/{projectId}/files/application	Upload application file in user project
GET /api/v2/users/{userId}/projects/{projectId}/files/data	Get data file in user project
POST /api/v2/users/{userId}/projects/{projectId}/files/data	Upload data file in user project
GET /api/v2/users/{userId}/projects/{projectId}/files/test	Get test file in user project
POST /api/v2/users/{userId}/projects/{projectId}/files/test	Upload test file in user project
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files	Get list of files in user test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files.zip	Get zip file with artifacts of user test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/application	Get application file in user project
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/application/check-results	Get application file in user project
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/data	Get data file in user project
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/test	Get test file in user project

Tag: device-group

Device Group

Operation	Description
GET /api/v2/device-groups	Get device groups
POST /api/v2/device-groups/{deviceGroupId}/devices	Add device to device group
DELETE /api/v2/device-groups/{deviceGroupId}/devices/{deviceModelId}	Delete device from device group
GET /api/v2/projects/{projectId}/public-device-groups	Get public device groups for project
GET /api/v2/users/{id}/device-groups	Get the device group list of user with specific ID
POST /api/v2/users/{id}/device-groups	Create device group for user
GET /api/v2/users/{userId}/device-groups/{deviceGroupId}	Get the device group of user with specific ID
POST /api/v2/users/{userId}/device-groups/{deviceGroupId}	Update the device group of user with specific ID
DELETE /api/v2/users/{userId}/device-groups/{deviceGroupId}	Delete the device group of user with specific ID
GET /api/v2/users/{userId}/device-groups/{deviceGroupId}/devices	Get device list of user device group
POST /api/v2/users/{userId}/device-groups/{deviceGroupId}/devices	Add device to device group
DELETE /api/v2/users/{userId}/device-groups/{deviceGroupId}/devices/{deviceId}	Delete device from device group
GET /api/v2/users/{userId}/projects/{projectId}/public-device-groups	Get public device groups for project

Tag: label

Label

Operation	Description
GET /api/v2/label-groups	Get the label group list
POST /api/v2/label-groups	Create label group
GET /api/v2/label-groups/{groupId}/labels	Get the label list of label group
POST /api/v2/label-groups/{groupId}/labels	Add label into label group
GET /api/v2/label-groups/{groupId}/labels/{labelId}	Get the label from label group
DELETE /api/v2/label-groups/{groupId}/labels/{labelId}	Delete label
GET /api/v2/label-groups/{groupId}/labels/{labelId}/devices	Get device list of label
POST /api/v2/label-groups/{groupId}/labels/{labelId}/devices	Add device to label
DELETE /api/v2/label-groups/{groupId}/labels/{labelId}/devices/{deviceId}	Delete device from label
GET /api/v2/label-groups/{id}	Get label group with specific ID
POST /api/v2/label-groups/{id}	Update label group with specific ID
DELETE /api/v2/label-groups/{id}	Delete label group with specific ID

Tag: admin

Admin

Operation	Description
GET /api/v2/admin/account-services/{serviceId}	Get account service
POST /api/v2/admin/account-services/{serviceId}/activate	Activate account service
POST /api/v2/admin/account-services/{serviceId}/deactivate	Deactivate account service
GET /api/v2/admin/accounts	Get accounts list
POST /api/v2/admin/accounts/{accountId}	Update account
GET /api/v2/admin/active-users	Get the active users list
GET /api/v2/admin/billing-periods	Get all billing periods
POST /api/v2/admin/billing-periods/{billingPeriodId}	Mark billing period as paid
GET /api/v2/admin/device-models	Get device models
POST /api/v2/admin/device-models/{deviceModelId}	Update device model
GET /api/v2/admin/device-problems	Get device problems
GET /api/v2/admin/device-sessions	Get device sessions for device model with specific id
POST /api/v2/admin/device-sessions/{deviceSessionId}/changebillable	Change billable status for device session
GET /api/v2/admin/device-time/count-session-report	Get device time, counted testRuns and deviceSessions per day, user, project, deviceModel
GET /api/v2/admin/device-time/step-time-report	Get device,preparing and waiting time per day, user, project, deviceModel
GET /api/v2/admin/device-types	Get device (image) types
GET /api/v2/admin/device/statuses	Get the device statuses list
GET /api/v2/admin/devices	Get the device list for admin
GET /api/v2/admin/devices/battery-level	Get the device list of devices with battery in range [minBatteryLevel, maxBatteryLevel]
GET /api/v2/admin/devices/without-internet	Get the device list of devices without internet
DELETE /api/v2/admin/devices/{deviceId}	Delete device
POST /api/v2/admin/devices/{deviceId}/properties	Add device to label
DELETE /api/v2/admin/devices/{deviceId}/properties/{propertyId}	Delete device from label
GET /api/v2/admin/devices/{id}/queue	Get the device queue
GET /api/v2/admin/errors	Get errors
GET /api/v2/admin/interactive-queue	Get interactive queue
GET /api/v2/admin/licenses	Get all users' licenses
POST /api/v2/admin/logsql	Sets SQL logging state
GET /api/v2/admin/overview	Get overview status
GET /api/v2/admin/payment-notifications	Get configuration for notification email
POST /api/v2/admin/payment-notifications	Save configuration for notification email
GET /api/v2/admin/roles	Get all available roles
GET /api/v2/admin/runs	Get admin test runs list
POST /api/v2/admin/runs/{testRunId}/changebillable	Change billable status for all device sessions in test run
GET /api/v2/admin/services	Get all available services
POST /api/v2/admin/services	Create service
GET /api/v2/admin/services/{serviceId}	Get service
DELETE /api/v2/admin/services/{serviceId}	Archive service
POST /api/v2/admin/services/{serviceId}/activate	Activate service
GET /api/v2/admin/services/{serviceId}/roles	Get service roles
POST /api/v2/admin/services/{serviceId}/roles	Add service role
DELETE /api/v2/admin/services/{serviceId}/roles	Delete service role
GET /api/v2/admin/settings	Get settings
GET /api/v2/admin/users	Get all users
POST /api/v2/admin/users	Create new user
GET /api/v2/admin/users/report.csv	Generate users csv report
GET /api/v2/admin/users/{userId}/account/roles	Get roles for specific user's account
POST /api/v2/admin/users/{userId}/account/roles	Add role to specific user's account
DELETE /api/v2/admin/users/{userId}/account/roles/{accountRoleId}	Delete role from specific user's account
GET /api/v2/admin/users/{userId}/account/services	Get account services
POST /api/v2/admin/users/{userId}/account/services	Add service to user
DELETE /api/v2/admin/users/{userId}/disable	Disable user
POST /api/v2/admin/users/{userId}/enable	Enable user
POST /api/v2/admin/users/{userId}/resend-activation	Resend activation email
POST /api/v2/admin/users/{userId}/update-account	Update users main account
GET /api/v2/clusters	Get device cluster list
POST /api/v2/clusters	Create physical device cluster
GET /api/v2/clusters/{id}	Get cluster by id
POST /api/v2/clusters/{id}	Update cluster by id
DELETE /api/v2/clusters/{id}	Delete cluster by id
GET /api/v2/clusters/{id}/devices	Get cluster by id with devices list
GET /api/v2/job-configs	Get the job config list
POST /api/v2/job-configs	Create job config
POST /api/v2/job-configs/resources	Update job config from resources
GET /api/v2/job-configs/types/{type}	Get job config with specific type
POST /api/v2/job-configs/types/{type}	Update job config with specific type
GET /api/v2/job-configs/{id}	Get job config with specific ID
POST /api/v2/job-configs/{id}	Update job config with specific ID
DELETE /api/v2/job-configs/{id}	Rollback job config with specific ID
GET /api/v2/properties	Get the property list
POST /api/v2/properties	Create property
POST /api/v2/properties/app-bans	Create property banning application
POST /api/v2/properties/email-bans	Create property banning email domain
POST /api/v2/properties/{id}	Update property
DELETE /api/v2/properties/{id}	Delete property by id
GET /api/v2/sessions	Get the session list
POST /api/v2/sessions	Create session (login)
GET /api/v2/sessions/{id}	Get session with specific ID
POST /api/v2/sessions/{id}	Close session (logout)

Tag: device

Device

Operation	Description
GET /api/v2/devices	Get the device list
GET /api/v2/devices/{deviceModelId}	Get device
GET /api/v2/devices/{id}/properties	Get the property list for device (model) with specific ID

Tag: user

User

Operation	Description
GET /api/v2/projects/{projectId}/notifications	Get the notification email list of specified project
POST /api/v2/projects/{projectId}/notifications	Create the notification email of user
GET /api/v2/users	Get all users (restricted by offset, limit, search phrase and order)
POST /api/v2/users	Register new user
POST /api/v2/users/activate	Activate user after registration
POST /api/v2/users/password-recovery	Set new password after recovery
GET /api/v2/users/recoveries	Get user by recovery key
POST /api/v2/users/recoveries	Generate recovery key for user
GET /api/v2/users/validate-activation	Check if activation or password reset link is valid
GET /api/v2/users/validateVatId	Is EU VAT ID correct
GET /api/v2/users/{id}	Get user with specific ID
POST /api/v2/users/{id}	Update user with specific ID
GET /api/v2/users/{id}/available-project-types	Get project types available for user
POST /api/v2/users/{id}/reset-api-key	Reset api key
DELETE /api/v2/users/{id}/runs	Delete all test runs of user with specific ID
GET /api/v2/users/{userId}/account/additional-users	Get additional users
POST /api/v2/users/{userId}/account/additional-users	Add additional user
POST /api/v2/users/{userId}/account/additional-users/{additionalUserId}	Enable additional user
DELETE /api/v2/users/{userId}/account/additional-users/{additionalUserId}	Disable additional user
POST /api/v2/users/{userId}/feedback	Create feedback email from user
POST /api/v2/users/{userId}/log-activity	Log user activity
GET /api/v2/users/{userId}/notifications	Get the notification email list of user with specific id
POST /api/v2/users/{userId}/notifications	Create the notification email of user
GET /api/v2/users/{userId}/notifications/{id}	Get the notification email of user with specific ID
POST /api/v2/users/{userId}/notifications/{id}	Update the notification email of user with specific ID
DELETE /api/v2/users/{userId}/notifications/{id}	Delete the notification email of user with specific ID
GET /api/v2/users/{userId}/projects/{projectId}/notifications	Get the notification email list of user with specific id for specified project
POST /api/v2/users/{userId}/projects/{projectId}/notifications	Create the notification email of user
GET /api/v2/users/{userId}/receipts	Get receipt for users service
GET /api/v2/users/{userId}/ui-preferences	Load user ui preferences
POST /api/v2/users/{userId}/ui-preferences	Store user ui preferences

Tag: project

Project

Operation	Description
GET /api/v2/projects	Get the project list
GET /api/v2/projects/{projectId}	Get project with specific ID
POST /api/v2/projects/{projectId}	Update user project with specific id
DELETE /api/v2/projects/{projectId}	Delete project with specific ID
GET /api/v2/projects/{projectId}/config	Get project test run config
POST /api/v2/projects/{projectId}/config	Update project test run config
GET /api/v2/projects/{projectId}/config/parameters	Get project test run config parameters
POST /api/v2/projects/{projectId}/config/parameters	Add project test run config parameters
GET /api/v2/projects/{projectId}/config/parameters/{parameterId}	Get project test run config parameter
DELETE /api/v2/projects/{projectId}/config/parameters/{parameterId}	Delete project test run config parameter
GET /api/v2/projects/{projectId}/device-groups	Get list of available device groups for project
GET /api/v2/projects/{projectId}/icon	Serves icon of project
GET /api/v2/projects/{projectId}/job-configs/{type}	Get project job config of given type
POST /api/v2/projects/{projectId}/job-configs/{type}	Updates project job config of given type
DELETE /api/v2/projects/{projectId}/job-configs/{type}	Rollbacks project job config of given type
GET /api/v2/projects/{projectId}/runs/{runId}/config	Get test run config
POST /api/v2/projects/{projectId}/runs/{runId}/config	Update test run config
GET /api/v2/projects/{projectId}/runs/{runId}/config/parameters	Get project test run config parameters
GET /api/v2/projects/{projectId}/runs/{runId}/config/parameters/{parameterId}	Get project test run config parameter
POST /api/v2/projects/{projectId}/unarchive	Unarchive project with specific ID
GET /api/v2/runs/{runId}/config	Get test run config
POST /api/v2/runs/{runId}/config	Update test run config
GET /api/v2/runs/{runId}/config/parameters	Get test run config parameters
GET /api/v2/runs/{runId}/config/parameters/{parameterId}	Get test run config parameter
GET /api/v2/users/{id}/projects	Get the project list of user with specific ID
POST /api/v2/users/{id}/projects	Create project for authenticated user
GET /api/v2/users/{userId}/projects/{projectId}	Get user project with specific ID
POST /api/v2/users/{userId}/projects/{projectId}	Update user project with specific id
DELETE /api/v2/users/{userId}/projects/{projectId}	Delete user project with specific ID
GET /api/v2/users/{userId}/projects/{projectId}/config	Get project test run config
POST /api/v2/users/{userId}/projects/{projectId}/config	Update project test run config
GET /api/v2/users/{userId}/projects/{projectId}/config/parameters	Get project test run config parameters
POST /api/v2/users/{userId}/projects/{projectId}/config/parameters	Add project test run config parameters
GET /api/v2/users/{userId}/projects/{projectId}/config/parameters/{parameterId}	Get project test run config parameter
DELETE /api/v2/users/{userId}/projects/{projectId}/config/parameters/{parameterId}	Delete project test run config parameter
GET /api/v2/users/{userId}/projects/{projectId}/device-groups	Get list of available device groups for project
GET /api/v2/users/{userId}/projects/{projectId}/icon	Serves icon of user project
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config	Get user test run config
POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config	Update test run config
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters	Get project test run config parameters
POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters	Add project test run config parameters
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters/{parameterId}	Get project test run config parameter
DELETE /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters/{parameterId}	Delete project test run config parameter
GET /api/v2/users/{userId}/projects/{projectId}/sharings	Get project sharings of user specified by ID
POST /api/v2/users/{userId}/projects/{projectId}/sharings	Share project to specified by email
GET /api/v2/users/{userId}/projects/{projectId}/sharings/{sharingId}	Get project sharing of user specified by ID
DELETE /api/v2/users/{userId}/projects/{projectId}/sharings/{sharingId}	Delete project sharing of user specified by ID

Tag: report

Report

Operation	Description
GET /api/v2/projects/{projectId}/reports/summary	Get summary report for project
GET /api/v2/projects/{projectId}/runs/{runId}/reports/detail-failures	Get detail failures report for test run
GET /api/v2/projects/{projectId}/runs/{runId}/reports/failures	Get failures report for test run
GET /api/v2/projects/{projectId}/runs/{runId}/reports/summary	Get summary report for test run
GET /api/v2/runs/{runId}/reports/detail-failures	Get detail failures report for test run
GET /api/v2/runs/{runId}/reports/failures	Get failures report for test run
GET /api/v2/runs/{runId}/reports/summary	Get summary report for test run
GET /api/v2/users/{userId}/projects/{projectId}/reports/summary	Get summary report for project
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/cucumber	Get cucumber test run report for calabash project
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/detail-failures	Get detail failures report for test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/failures	Get failures report for test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/summary	Get summary report for test run

Tag: license

License

Operation	Description
GET /api/v2/license	Get license installed to cloud

Tag: device-session

Device Session

Operation	Description
GET /api/v2/device-sessions/{deviceSessionId}/input-file-set/files.zip	Get device session files.zip
GET /api/v2/device-sessions/{deviceSessionId}/output-file-set/files	Get output files for device session by tag
GET /api/v2/device-sessions/{deviceSessionId}/output-file-set/files.zip	Get device session output files.zip
POST /api/v2/device-sessions/{deviceSessionId}/release	Releases users device session
POST /api/v2/device-sessions/{deviceSessionId}/results.zip	Post results of a device session
GET /api/v2/device-sessions/{deviceSessionId}/steps	Get the device session steps of device session
POST /api/v2/device-sessions/{deviceSessionId}/steps	Add or Update device session step
GET /api/v2/device-sessions/{deviceSessionId}/steps/current	Get the current device session step of device session
GET /api/v2/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}	Get the device session step of device session
GET /api/v2/device-sessions/{sessionId}/connections	Get connections for Inspector device session
POST /api/v2/device-sessions/{sessionId}/connections	Create connection for device session
GET /api/v2/device-sessions/{sessionId}/connections/{connectionId}	Get connection for Inspector device session
GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions	Get the device session list of user test run
GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files	Get output files for device session by tag
GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files.zip	Get device session output files.zip
GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps	Get the device session steps of device session
GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/current	Get the current device session step of device session
GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}	Get the device session step of device session
GET /api/v2/projects/{projectId}/runs/{testRunId}/steps	Get device session steps of all device sessions in run
GET /api/v2/runs/{runId}/device-sessions	Get the device session list of user test run
GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files	Get output files for device session by tag
GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files.zip	Get device session output files.zip
GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/steps	Get the device session steps of device session
GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/steps/current	Get the current device session step of device session
GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}	Get the device session step of device session
GET /api/v2/runs/{testRunId}/steps	Get device session steps of all device sessions in run
GET /api/v2/users/{userId}/device-sessions	Get Inspector device sessions
POST /api/v2/users/{userId}/device-sessions	Create Inspector device session
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/files.zip	Get device session output files.zip
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes	Get notes for device session
POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes	Add note to device session
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}	Get note for device session
POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}	Update note for device session
DELETE /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}	Delete note from device session
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}/file	Download note for device session
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots	Get screenshots for device session
POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots	Add screenshot to device session
POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/screenshots.zip	Request for generating screenshot zip from user's Interactive device session
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/{screenshotFileId}	Get screenshot for device session
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/{screenshotFileId}/file	Download screenshot for device session
DELETE /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/{screenshotId}	Delete screenshot from device session
POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/release	Releases users device session
GET /api/v2/users/{userId}/device-sessions/{sessionId}	Get Inspector device session
GET /api/v2/users/{userId}/device-sessions/{sessionId}/connections	Get connections for Inspector device session
POST /api/v2/users/{userId}/device-sessions/{sessionId}/connections	Create connection for device session
GET /api/v2/users/{userId}/device-sessions/{sessionId}/connections/{connectionId}	Get connection for Inspector device session
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions	Get the device session list of user test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files	Get output files for device session by tag
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files.zip	Get device session output files.zip
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps	Get the device session steps of device session
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/current	Get the current device session step of device session
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}	Get the device session step of device session
GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/steps	Get device session steps of all device sessions in run

Tag: test-run

Test run

Operation	Description
GET /api/v2/projects/{id}/runs	Get project test run list
POST /api/v2/projects/{projectId}/runs	Run project for authenticated user using default project configuration
GET /api/v2/projects/{projectId}/runs-extended	Get the test run list of user project
GET /api/v2/projects/{projectId}/runs-extended/{runId}	Get extended test run from user project
GET /api/v2/projects/{projectId}/runs/{runId}	Get test run from project
POST /api/v2/projects/{projectId}/runs/{runId}	Update test run in project
DELETE /api/v2/projects/{projectId}/runs/{runId}	Delete test run from project
POST /api/v2/projects/{projectId}/runs/{runId}/abort	Abort test run from project, and receive partial results
POST /api/v2/projects/{projectId}/runs/{testRunId}/apps-data.zip	Request for generating apps and data zip from project
POST /api/v2/projects/{projectId}/runs/{testRunId}/build-logs.zip	Request for generating build logs zip from project's test run
GET /api/v2/projects/{projectId}/runs/{testRunId}/data-availability	Get test run data availability
POST /api/v2/projects/{projectId}/runs/{testRunId}/files.zip	Request for generating files zip from project
POST /api/v2/projects/{projectId}/runs/{testRunId}/logs.zip	Request for generating logs zip from project
POST /api/v2/projects/{projectId}/runs/{testRunId}/performance.zip	Request for generating performance zip from project's test run
POST /api/v2/projects/{projectId}/runs/{testRunId}/retry	Retry test run or its device runs
POST /api/v2/projects/{projectId}/runs/{testRunId}/screenshots.zip	Request for generating screenshot zip from project's test run
POST /api/v2/projects/{projectId}/runs/{testRunId}/start	Start test run or its device runs
GET /api/v2/projects/{projectId}/runs/{testRunId}/tags	Get test run tag list from project test run
POST /api/v2/projects/{projectId}/runs/{testRunId}/tags	Add test run tag to test run
GET /api/v2/projects/{projectId}/runs/{testRunId}/tags/{tagId}	Get test run tag from test run
DELETE /api/v2/projects/{projectId}/runs/{testRunId}/tags/{tagId}	Delete test run tag
GET /api/v2/runs	Get the test run list
POST /api/v2/runs	Create Testrun
GET /api/v2/runs/{runId}	Get test run
POST /api/v2/runs/{runId}	Update test run name
DELETE /api/v2/runs/{runId}	Delete test run
POST /api/v2/runs/{runId}/abort	Abort test run, and receive partial results
POST /api/v2/runs/{testRunId}/apps-data.zip	Request for generating apps and data zip from test run
POST /api/v2/runs/{testRunId}/build-logs.zip	Request for generating build logs zip from test run
GET /api/v2/runs/{testRunId}/data-availability	Get test run data availability
POST /api/v2/runs/{testRunId}/files.zip	Request for generating files zip from test run
POST /api/v2/runs/{testRunId}/logs.zip	Request for generating logs zip from test run
POST /api/v2/runs/{testRunId}/performance.zip	Request for generating performance zip from test run
POST /api/v2/runs/{testRunId}/retry	Retry test run or its device runs
POST /api/v2/runs/{testRunId}/screenshots.zip	Request for generating screenshot zip from test run
POST /api/v2/runs/{testRunId}/start	Start test run or its device runs
GET /api/v2/runs/{testRunId}/tags	Get tag list from test run
POST /api/v2/runs/{testRunId}/tags	Add tag to test run
GET /api/v2/runs/{testRunId}/tags/{tagId}	Get test run tag from user's test run
DELETE /api/v2/runs/{testRunId}/tags/{tagId}	Delete test run tag
POST /api/v2/users/{id}/projects/{projectId}/runs	Run project for authenticated user using default project configuration
GET /api/v2/users/{id}/runs	Get the test run list of authenticated user
GET /api/v2/users/{userId}/projects/{projectId}/runs	Get the test run list of user project
GET /api/v2/users/{userId}/projects/{projectId}/runs-extended	Get the test run list of user project
GET /api/v2/users/{userId}/projects/{projectId}/runs-extended/{runId}	Get extended test run from user project
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}	Get test run from user's project
POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}	Update test run in user's project
DELETE /api/v2/users/{userId}/projects/{projectId}/runs/{runId}	Delete test run from user's project
POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/abort	Abort test run from user's project, and receive partial results
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/apps-data.zip	Request for generating apps and data zip from user's test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/data-availability	Get test run data availability
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/files.zip	Request for generating files zip from user's test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/logs.zip	Request for generating logs zip from user's test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/performance.zip	Request for generating performance zip from user's test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/retry	Retry test run or its device runs
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/screenshots.zip	Request for generating screenshot zip from user's test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/start	Start test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags	Get test run tag list from user's test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags	Add test run tag to user's test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags/{tagId}	Get test run tag from user's test run
DELETE /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags/{tagId}	Delete test run tag from user's test run

Paths

Get account service

GET /api/v2/admin/account-services/{serviceId}

Tags: admin

application/json


serviceId	serviceId	path	integer (int64)

*/*

200 OK: OK

APIAccountService
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Activate account service

POST /api/v2/admin/account-services/{serviceId}/activate

Tags: admin

application/json


serviceId	serviceId	path	integer (int64)
forSeconds	seconds	query	integer (int32)
sendMail	sendMail	query	boolean

*/*

200 OK: OK

APIAccountService
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Deactivate account service

POST /api/v2/admin/account-services/{serviceId}/deactivate

Tags: admin

application/json


serviceId	serviceId	path	integer (int64)

*/*

200 OK: OK

APIAccountService
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get accounts list

GET /api/v2/admin/accounts

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APIAccount»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update account

POST /api/v2/admin/accounts/{accountId}

Tags: admin

application/json


accountId	accountId	path	integer (int64)
maxTimeout	maxTimeout	query	integer (int32)
testScreenshotLimit	testScreenshotLimit	query	integer (int32)

*/*

200 OK: OK

APIAccount
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the active users list

GET /api/v2/admin/active-users

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APIActiveUser»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all billing periods

GET /api/v2/admin/billing-periods

Tags: admin

application/json

*/*

200 OK: OK

APIList«APIBillingPeriod»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Mark billing period as paid

POST /api/v2/admin/billing-periods/{billingPeriodId}

Tags: admin

application/json


billingPeriodId	billingPeriodId	path	integer (int64)

*/*

200 OK: OK

APIBillingPeriod
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device models

GET /api/v2/admin/device-models

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APIAdminDeviceModel»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update device model

POST /api/v2/admin/device-models/{deviceModelId}

Tags: admin

application/json


deviceModelId	deviceModelId	path	integer (int64)
releaseVersion	releaseVersion	query	string
apiLevel	apiLevel	query	integer (int32)
name	name	query	string
enabled	enabled	query	boolean
vncSupported	vncSupported	query	boolean
aroSupported	aroSupported	query	boolean
typeId	typeId	query	integer (int64)
creditsPrice	creditsPrice	query	integer (int32)

*/*

200 OK: OK

APIDevice
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device problems

GET /api/v2/admin/device-problems

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APIAdminDeviceProblem»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device sessions for device model with specific id

GET /api/v2/admin/device-sessions

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APIAdminDeviceSession»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Change billable status for device session

POST /api/v2/admin/device-sessions/{deviceSessionId}/changebillable

Tags: admin

application/json


deviceSessionId	deviceSessionId	path	integer (int64)
billable	billable	query	boolean

*/*

200 OK: OK

APIDeviceSession
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get entire device time history

GET /api/v2/admin/device-time

Tags: account-service

application/json


withAdditionalUsers	withAdditionalUsers	query	boolean

*/*

200 OK: OK

APIUserDeviceTime
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device time, counted testRuns and deviceSessions per day, user, project, deviceModel

GET /api/v2/admin/device-time/count-session-report

Tags: admin

application/json

*/*

200 OK: OK

APIList«APIDeviceTimeCountSessionReportEntry»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device,preparing and waiting time per day, user, project, deviceModel

GET /api/v2/admin/device-time/step-time-report

Tags: admin

application/json

*/*

200 OK: OK

APIList«APIDeviceTimeStepTimeReportEntry»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device (image) types

GET /api/v2/admin/device-types

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APIAdminDeviceType»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device statuses list

GET /api/v2/admin/device/statuses

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APIDeviceStatus»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device list for admin

GET /api/v2/admin/devices

Tags: admin

application/json


withDisabled	withDisabled	query	boolean

*/*

200 OK: OK

APIAdminList«APIAdminDevice»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device list of devices with battery in range [minBatteryLevel, maxBatteryLevel]

GET /api/v2/admin/devices/battery-level

Tags: admin

application/json


minBatteryLevel	minBatteryLevel	query	integer (int64)
maxBatteryLevel	maxBatteryLevel	query	integer (int64)

*/*

200 OK: OK

APIAdminList«APIAdminDevice»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device list of devices without internet

GET /api/v2/admin/devices/without-internet

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APIAdminDevice»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete device

DELETE /api/v2/admin/devices/{deviceId}

Tags: admin

application/json


deviceId	deviceId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Add device to label

POST /api/v2/admin/devices/{deviceId}/properties

Tags: admin

application/json


deviceId	deviceId	path	integer (int64)
labelId	labelId	query	integer (int64)

*/*

201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete device from label

DELETE /api/v2/admin/devices/{deviceId}/properties/{propertyId}

Tags: admin

application/json


deviceId	deviceId	path	integer (int64)
propertyId	propertyId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the device queue

GET /api/v2/admin/devices/{id}/queue

Tags: admin

Ignores sort value. Sorts by order in queue.

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get errors

GET /api/v2/admin/errors

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APIAdminError»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get interactive queue

GET /api/v2/admin/interactive-queue

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APIAdminInteractiveDeviceSession»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all users' licenses

GET /api/v2/admin/licenses

Tags: admin

application/json

*/*

200 OK: OK

APIList«APILicense»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Sets SQL logging state

POST /api/v2/admin/logsql

Tags: admin

application/json


enabled	enabled	query	boolean

*/*

200 OK
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get overview status

GET /api/v2/admin/overview

Tags: admin

application/json

*/*

200 OK: OK

APIAdminOverview
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get configuration for notification email

GET /api/v2/admin/payment-notifications

Tags: admin

application/json

*/*

200 OK: OK

APIEmailNotification
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Save configuration for notification email

POST /api/v2/admin/payment-notifications

Tags: admin

application/json


subject	subject	query	string
message	message	query	string
toggle	toggle	query	boolean
userIds[]	userIds	query	integer[] , multiple parameters (`userIds[]=aaa&userIds[]=bbb`)

*/*

201 Created: Created

APIEmailNotification
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all available roles

GET /api/v2/admin/roles

Tags: admin

application/json

*/*

200 OK: OK

APIList«APIRole»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get admin test runs list

GET /api/v2/admin/runs

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APIAdminTestRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Change billable status for all device sessions in test run

POST /api/v2/admin/runs/{testRunId}/changebillable

Tags: admin

application/json


testRunId	testRunId	path	integer (int64)
billable	billable	query	boolean

*/*

200 OK: OK

APIAdminTestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all available services

GET /api/v2/admin/services

Tags: admin

application/json

*/*

200 OK: OK

APIList«APIService»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create service

POST /api/v2/admin/services

Tags: admin

application/json


name	name	query	string
description	description	query	string
centPrice	centPrice	query	integer (int32)
includedHours	includedHours	query	integer (int32)
pricePerHour	pricePerHour	query	integer (int32)
autoRenew	autoRenew	query	boolean
customPlan	customPlan	query	boolean
braintreeId	braintreeId	query	string
roles[]	roles	query	integer[] , multiple parameters (`roles[]=aaa&roles[]=bbb`)

*/*

201 Created: Created

APIService
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Archive service

DELETE /api/v2/admin/services/{serviceId}

Tags: admin

application/json


serviceId	serviceId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get service

GET /api/v2/admin/services/{serviceId}

Tags: admin

application/json


serviceId	serviceId	path	integer (int64)

*/*

200 OK: OK

APIService
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Activate service

POST /api/v2/admin/services/{serviceId}/activate

Tags: admin

application/json


serviceId	serviceId	path	integer (int64)
activateTime	activateTime	query	integer (int64)

*/*

200 OK: OK

APIService
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete service role

DELETE /api/v2/admin/services/{serviceId}/roles

Tags: admin

application/json


serviceId	serviceId	path	integer (int64)
roleIds[]	roleIds	query	integer[] , multiple parameters (`roleIds[]=aaa&roleIds[]=bbb`)

*/*

200 OK: APIService
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get service roles

GET /api/v2/admin/services/{serviceId}/roles

Tags: admin

application/json


serviceId	serviceId	path	integer (int64)

*/*

200 OK: OK

APIList«APIRole»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add service role

POST /api/v2/admin/services/{serviceId}/roles

Tags: admin

application/json


serviceId	serviceId	path	integer (int64)
roleIds[]	roleIds	query	integer[] , multiple parameters (`roleIds[]=aaa&roleIds[]=bbb`)

*/*

200 OK: APIService
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get settings

GET /api/v2/admin/settings

Tags: admin

application/json


reload	reload	query	boolean

*/*

200 OK: OK

object
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all users

GET /api/v2/admin/users

Tags: admin

application/json


onlyMainUsers	onlyMainUsers	query	boolean
onlyWithDisabledServices	onlyWithDisabledServices	query	boolean
withRole	withRole	query	string

*/*

200 OK: OK

APIList«APIUser»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create new user

POST /api/v2/admin/users

Tags: admin

application/json


email	email	query	string

*/*

201 Created: Created

APIUser
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Generate users csv report

GET /api/v2/admin/users/report.csv

Tags: admin

application/json


fromTimestamp	fromTimestamp	query	integer (int64)

text/csv;charset=UTF-8

200 OK: OK

User
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get roles for specific user's account

GET /api/v2/admin/users/{userId}/account/roles

Tags: admin

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIRole»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add role to specific user's account

POST /api/v2/admin/users/{userId}/account/roles

Tags: admin

application/json


userId	userId	path	integer (int64)
roleId	roleId	query	integer (int64)

*/*

200 OK: APIRole
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete role from specific user's account

DELETE /api/v2/admin/users/{userId}/account/roles/{accountRoleId}

Tags: admin

application/json


userId	userId	path	integer (int64)
accountRoleId	accountRoleId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get account services

GET /api/v2/admin/users/{userId}/account/services

Tags: admin

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIAccountService»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add service to user

POST /api/v2/admin/users/{userId}/account/services

Tags: admin

application/json


userId	userId	path	integer (int64)
serviceId	serviceId	query	integer (int64)

*/*

200 OK: OK

APIAccountService
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Disable user

DELETE /api/v2/admin/users/{userId}/disable

Tags: admin

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIUser
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Enable user

POST /api/v2/admin/users/{userId}/enable

Tags: admin

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Resend activation email

POST /api/v2/admin/users/{userId}/resend-activation

Tags: admin

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update users main account

POST /api/v2/admin/users/{userId}/update-account

Tags: admin

application/json


userId	userId	path	integer (int64)
accountId	accountId	query	integer (int64)

*/*

200 OK: OK
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device cluster list

GET /api/v2/clusters

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APICluster»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create physical device cluster

POST /api/v2/clusters

Tags: admin

application/json


name	name	query	string
url	url	query	string

*/*

201 Created: Created

APICluster
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete cluster by id

DELETE /api/v2/clusters/{id}

Tags: admin

application/json


id	id	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get cluster by id

GET /api/v2/clusters/{id}

Tags: admin

application/json


id	id	path	integer (int64)
withDevices	withDevices	query	boolean

*/*

200 OK: OK

APICluster
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update cluster by id

POST /api/v2/clusters/{id}

Tags: admin

application/json


id	id	path	integer (int64)
name	name	query	string
enabled	enabled	query	boolean
url	url	query	string

*/*

200 OK: OK

APICluster
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get cluster by id with devices list

GET /api/v2/clusters/{id}/devices

Tags: admin

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APIAdminList«APIAdminDevice»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device groups

GET /api/v2/device-groups

Tags: device-group

application/json

*/*

200 OK: OK

APIList«APIDeviceGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add device to device group

POST /api/v2/device-groups/{deviceGroupId}/devices

Tags: device-group

application/json


deviceGroupId	deviceGroupId	path	integer (int64)
deviceModelId	deviceModelId	query	integer (int64)

*/*

201 Created: Created

APIDeviceGroup
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete device from device group

DELETE /api/v2/device-groups/{deviceGroupId}/devices/{deviceModelId}

Tags: device-group

application/json


deviceGroupId	deviceGroupId	path	integer (int64)
deviceModelId	deviceModelId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get device run

GET /api/v2/device-runs/{deviceRunId}

Tags: device-runs

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK

APIDeviceRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get cluster build logs file

GET /api/v2/device-runs/{deviceRunId}/cluster-logs

Tags: device-runs

logs file as response body

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run data availability

GET /api/v2/device-runs/{deviceRunId}/data-availability

Tags: device-runs

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK

APIDeviceRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run fixtures.zip

GET /api/v2/device-runs/{deviceRunId}/fixtures.zip

Tags: device-runs

for cluster only

application/json


deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run junit file

GET /api/v2/device-runs/{deviceRunId}/junit.xml

Tags: device-runs

junit file as response body

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run logs file

GET /api/v2/device-runs/{deviceRunId}/logs

Tags: device-runs

logs file as response body

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run performance file

GET /api/v2/device-runs/{deviceRunId}/performance

Tags: device-runs

performance file as response body

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run result data.zip

GET /api/v2/device-runs/{deviceRunId}/result-data.zip

Tags: device-runs

result data.zip as response body

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the screenshot list of device run

GET /api/v2/device-runs/{deviceRunId}/screenshots

Tags: device-runs

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK

APIList«APIScreenshot»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run screenshot

GET /api/v2/device-runs/{deviceRunId}/screenshots/{screenshotId}

Tags: device-runs

screenshot file in response body

application/json


deviceRunId	deviceRunId	path	integer (int64)
screenshotId	screenshotId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state list of device run

GET /api/v2/device-runs/{deviceRunId}/states

Tags: device-runs

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRunState»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state of device run

GET /api/v2/device-runs/{deviceRunId}/states/{stateId}

Tags: device-runs

application/json


deviceRunId	deviceRunId	path	integer (int64)
stateId	stepId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK

APIDeviceRunState
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run steps

GET /api/v2/device-runs/{deviceRunId}/test-case-runs

Tags: device-runs

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK

APIList«APITestCaseRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session files.zip

GET /api/v2/device-sessions/{deviceSessionId}/input-file-set/files.zip

Tags: device-session

for cluster only

application/json


deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get output files for device session by tag

GET /api/v2/device-sessions/{deviceSessionId}/output-file-set/files

Tags: device-session

application/json


deviceSessionId	deviceSessionId	path	integer (int64)
tag[]	tags	query	string[] , multiple parameters (`tag[]=aaa&tag[]=bbb`)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session output files.zip

GET /api/v2/device-sessions/{deviceSessionId}/output-file-set/files.zip

Tags: device-session

application/json


deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Releases users device session

POST /api/v2/device-sessions/{deviceSessionId}/release

Tags: device-session

application/json


deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSession
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Post results of a device session

POST /api/v2/device-sessions/{deviceSessionId}/results.zip

Tags: device-session

for cluster only

multipart/form-data


deviceSessionId	deviceSessionId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session steps of device session

GET /api/v2/device-sessions/{deviceSessionId}/steps

Tags: device-session

application/json


deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add or Update device session step

POST /api/v2/device-sessions/{deviceSessionId}/steps

Tags: device-session

for clusters only

application/json


deviceSessionId	deviceSessionId	path	integer (int64)
type	type	query	string , x ∈ { WAITING , PREPARING , UNINSTALL , INSTALL , RUNNING , SENDING_RESULTS , PROCESSING_RESULTS }

*/*

201 Created: Created

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the current device session step of device session

GET /api/v2/device-sessions/{deviceSessionId}/steps/current

Tags: device-session

application/json


deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session step of device session

GET /api/v2/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}

Tags: device-session

application/json


deviceSessionId	deviceSessionId	path	integer (int64)
deviceSessionStepId	deviceSessionStepId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get connections for Inspector device session

GET /api/v2/device-sessions/{sessionId}/connections

Tags: device-session

application/json


sessionId	sessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIConnection»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create connection for device session

POST /api/v2/device-sessions/{sessionId}/connections

Tags: device-session

application/json


sessionId	sessionId	path	integer (int64)
host	host	query	string
port	port	query	integer (int32)
type	type	query	string
password	password	query	string

*/*

201 Created: Created

APIConnection
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get connection for Inspector device session

GET /api/v2/device-sessions/{sessionId}/connections/{connectionId}

Tags: device-session

application/json


sessionId	sessionId	path	integer (int64)
connectionId	connectionId	path	integer (int64)

*/*

200 OK: OK

APIConnection
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device list

GET /api/v2/devices

Tags: device

application/json


withDisabled	withDisabled	query	boolean
device_group_id[]	deviceGroupIds	query	integer[] , multiple parameters (`device_group_id[]=aaa&device_group_id[]=bbb`)
label_id[]	labelIds	query	integer[] , multiple parameters (`label_id[]=aaa&label_id[]=bbb`)
device_filter[]	filters	query	string[] , x ∈ { FREE , RECOMMENDED , NEW } , multiple parameters (`device_filter[]=aaa&device_filter[]=bbb`)

*/*

200 OK: OK

APIList«APIDevice»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device

GET /api/v2/devices/{deviceModelId}

Tags: device

application/json


deviceModelId	deviceModelId	path	integer (int64)
withDisabled	withDisabled	query	boolean

*/*

200 OK: OK

APIDevice
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the property list for device (model) with specific ID

GET /api/v2/devices/{id}/properties

Tags: device

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceProperty»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file set list

GET /api/v2/file-sets

Tags: file

application/json

*/*

200 OK: OK

APIList«APIFileSet»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create file set

POST /api/v2/file-sets

Tags: file

application/json


name	name	query	string

*/*

201 Created: Created

APIFileSet
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete the file set with specific ID

DELETE /api/v2/file-sets/{fileSetId}

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the file set with specific ID

GET /api/v2/file-sets/{fileSetId}

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)

*/*

200 OK: OK

APIFileSet
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update the file set with specific ID

POST /api/v2/file-sets/{fileSetId}

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)
name	name	query	string

*/*

200 OK: APIFileSet
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get file list of file set

GET /api/v2/file-sets/{fileSetId}/files

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add file to file set

POST /api/v2/file-sets/{fileSetId}/files

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	query	integer (int64)

*/*

200 OK: APIFileSet
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete file from file set

DELETE /api/v2/file-sets/{fileSetId}/files/{fileId}

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: APIFileSet
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get user file with specific ID

GET /api/v2/file-sets/{fileSetId}/files/{fileId}

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update file name with specific id

POST /api/v2/file-sets/{fileSetId}/files/{fileId}

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)
name	name	query	string

*/*

200 OK: APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download file from file set

GET /api/v2/file-sets/{fileSetId}/files/{fileId}/file

Tags: file

Returns file stream

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download icon of file from file set

GET /api/v2/file-sets/{fileSetId}/files/{fileId}/icon

Tags: file

Returns file stream

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file tags list

GET /api/v2/file-sets/{fileSetId}/files/{fileId}/tags

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFileTag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file list

GET /api/v2/files

Tags: file

application/json


tag[]	tags	query	string[] , multiple parameters (`tag[]=aaa&tag[]=bbb`)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload file

POST /api/v2/files

Tags: file

multipart/form-data


file	file	formData	file

*/*

201 Created: Created

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete file with specific ID

DELETE /api/v2/files/{fileId}

Tags: file

application/json


fileId	fileId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get user file with specific ID

GET /api/v2/files/{fileId}

Tags: file

application/json


fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update file name with specific id

POST /api/v2/files/{fileId}

Tags: file

application/json


fileId	fileId	path	integer (int64)
name	name	query	string

*/*

200 OK: APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download file

GET /api/v2/files/{fileId}/file

Tags: file

Returns file stream

application/json


fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download icon of file

GET /api/v2/files/{fileId}/icon

Tags: file

Returns file stream

application/json


fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file tags list

GET /api/v2/files/{fileId}/tags

Tags: file

application/json


fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFileTag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get available jira issue types

GET /api/v2/jira/issues/issue-types

Tags: jira

application/json

*/*

200 OK: OK

APIJiraIssueType
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get available jira issue priorities

GET /api/v2/jira/issues/priorities

Tags: jira

application/json

*/*

200 OK: OK

APIJiraPriority
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete issue with specified issueKey

DELETE /api/v2/jira/issues/{issueKey}

Tags: jira

application/json


issueKey	issueKey	path	string

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get issue with specified issueKey

GET /api/v2/jira/issues/{issueKey}

Tags: jira

application/json


issueKey	issueKey	path	string

*/*

200 OK: OK

APIJiraIssue
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update issue with specified issueKey

POST /api/v2/jira/issues/{issueKey}

Tags: jira

application/json


issueKey	issueKey	path	string
comment	comment	query	string

*/*

200 OK: APIJiraIssue
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get jira projects

GET /api/v2/jira/projects

Tags: jira

application/json

*/*

200 OK: OK

APIBasicJiraProject
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get jira projects

GET /api/v2/jira/projects/{projectKey}

Tags: jira

application/json


projectKey	projectKey	path	string

*/*

200 OK: OK

APIJiraProject
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get jira issues by projectKey

GET /api/v2/jira/projects/{projectKey}/issues

Tags: jira

application/json


projectKey	projectKey	path	string

*/*

200 OK: OK

APIList«APIJiraIssue»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create jira issue in project with specified projectId

POST /api/v2/jira/projects/{projectKey}/issues

Tags: jira

application/json


projectKey	projectKey	path	string
issueTypeId	issueTypeId	query	integer (int64)
summary	summary	query	string
description	description	query	string
priorityId	priorityId	query	integer (int64)

*/*

201 Created: Created

APIBasicJiraIssue
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get jira server info and validate connection

GET /api/v2/jira/server-info

Tags: jira

application/json

*/*

200 OK: OK

APIJiraServerInfo
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the job config list

GET /api/v2/job-configs

Tags: admin

application/json


global	global	query	boolean

*/*

200 OK: OK

APIList«APIProjectJobConfig»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create job config

POST /api/v2/job-configs

Tags: admin

application/json


content	content	query	string
type	type	query	string , x ∈ { DEFAULT , INSTATEST , INTERACTIVE , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
projectId	projectId	query	integer (int64)

*/*

201 Created: Created

APIProjectJobConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update job config from resources

POST /api/v2/job-configs/resources

Tags: admin

application/json

*/*

201 Created: Created

APIList«APIProjectJobConfig»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get job config with specific type

GET /api/v2/job-configs/types/{type}

Tags: admin

application/json


type	type	path	string , x ∈ { DEFAULT , INSTATEST , INTERACTIVE , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }

*/*

200 OK: OK

APIProjectJobConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update job config with specific type

POST /api/v2/job-configs/types/{type}

Tags: admin

application/json


type	type	path	string , x ∈ { DEFAULT , INSTATEST , INTERACTIVE , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
content	content	query	string

*/*

201 Created: Created

APIProjectJobConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Rollback job config with specific ID

DELETE /api/v2/job-configs/{id}

Tags: admin

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APIProjectJobConfig
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get job config with specific ID

GET /api/v2/job-configs/{id}

Tags: admin

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APIProjectJobConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update job config with specific ID

POST /api/v2/job-configs/{id}

Tags: admin

application/json


id	id	path	integer (int64)
content	content	query	string

*/*

200 OK: OK

APIProjectJobConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the label group list

GET /api/v2/label-groups

Tags: label

application/json

*/*

200 OK: OK

APIList«APILabelGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create label group

POST /api/v2/label-groups

Tags: label

application/json


name	name	query	string
displayName	displayName	query	string

*/*

201 Created: Created

APILabelGroup
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the label list of label group

GET /api/v2/label-groups/{groupId}/labels

Tags: label

application/json


groupId	groupId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceProperty»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add label into label group

POST /api/v2/label-groups/{groupId}/labels

Tags: label

application/json


groupId	groupId	path	integer (int64)
name	name	query	string
displayName	displayName	query	string

*/*

201 Created: Created

APIDeviceProperty
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete label

DELETE /api/v2/label-groups/{groupId}/labels/{labelId}

Tags: label

application/json


groupId	groupId	path	integer (int64)
labelId	labelId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the label from label group

GET /api/v2/label-groups/{groupId}/labels/{labelId}

Tags: label

application/json


groupId	groupId	path	integer (int64)
labelId	labelId	path	integer (int64)

*/*

200 OK: OK

APIDeviceProperty
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device list of label

GET /api/v2/label-groups/{groupId}/labels/{labelId}/devices

Tags: label

application/json


groupId	groupId	path	integer (int64)
labelId	labelId	path	integer (int64)

*/*

200 OK: OK

APIAdminList«APIAdminDevice»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add device to label

POST /api/v2/label-groups/{groupId}/labels/{labelId}/devices

Tags: label

application/json


groupId	groupId	path	integer (int64)
labelId	labelId	path	integer (int64)
id	deviceId	query	integer (int64)
removeExisting	removeExisting	query	boolean

*/*

201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete device from label

DELETE /api/v2/label-groups/{groupId}/labels/{labelId}/devices/{deviceId}

Tags: label

application/json


groupId	groupId	path	integer (int64)
labelId	labelId	path	integer (int64)
deviceId	deviceId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Delete label group with specific ID

DELETE /api/v2/label-groups/{id}

Tags: label

application/json


id	id	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get label group with specific ID

GET /api/v2/label-groups/{id}

Tags: label

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APILabelGroup
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update label group with specific ID

POST /api/v2/label-groups/{id}

Tags: label

application/json


id	id	path	integer (int64)
name	name	query	string
displayName	displayName	query	string
hidden	hidden	query	boolean

*/*

200 OK: OK

APILabelGroup
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get license installed to cloud

GET /api/v2/license

Tags: license

application/json

*/*

200 OK: OK

APILicense
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the project list

GET /api/v2/projects

Tags: project

application/json

*/*

200 OK: OK

APIList«APIProject»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run list

GET /api/v2/projects/{id}/runs

Tags: test-run

application/json


id	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete project with specific ID

DELETE /api/v2/projects/{projectId}

Tags: project

application/json


projectId	projectId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get project with specific ID

GET /api/v2/projects/{projectId}

Tags: project

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIProject
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update user project with specific id

POST /api/v2/projects/{projectId}

Tags: project

application/json


projectId	projectId	path	integer (int64)
name	name	query	string
description	description	query	string
common	common	query	boolean
archivingStrategy	archivingStrategy	query	string , x ∈ { NEVER , DAYS , RUNS }
archivingItemCount	archivingItemCount	query	integer (int32)

*/*

200 OK: APIProject
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config

GET /api/v2/projects/{projectId}/config

Tags: project

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APITestRunConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update project test run config

POST /api/v2/projects/{projectId}/config

Tags: project

application/json


projectId	projectId	path	integer (int64)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
gamebenchEnabled	gamebenchEnabled	query	boolean
videoRecordingEnabled	videoRecordingEnabled	query	boolean
timeout	timeout	query	integer (int64)

*/*

200 OK: OK

APITestRunConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config parameters

GET /api/v2/projects/{projectId}/config/parameters

Tags: project

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunParameter»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add project test run config parameters

POST /api/v2/projects/{projectId}/config/parameters

Tags: project

application/json


projectId	projectId	path	integer (int64)
key	key	query	string
value	value	query	string

*/*

201 Created: Created

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete project test run config parameter

DELETE /api/v2/projects/{projectId}/config/parameters/{parameterId}

Tags: project

application/json


projectId	projectId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get project test run config parameter

GET /api/v2/projects/{projectId}/config/parameters/{parameterId}

Tags: project

application/json


projectId	projectId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

200 OK: OK

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of available device groups for project

GET /api/v2/projects/{projectId}/device-groups

Tags: project

Serves icon stream in response body

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of files in user project

GET /api/v2/projects/{projectId}/files

Tags: file

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIFiles
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get zip file with artifacts of user project

GET /api/v2/projects/{projectId}/files.zip

Tags: file

zip stream is returned

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/projects/{projectId}/files/application

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload application file in user project

POST /api/v2/projects/{projectId}/files/application

Tags: file

multipart/form-data


projectId	projectId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get data file in user project

GET /api/v2/projects/{projectId}/files/data

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload data file in user project

POST /api/v2/projects/{projectId}/files/data

Tags: file

multipart/form-data


projectId	projectId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test file in user project

GET /api/v2/projects/{projectId}/files/test

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload test file in user project

POST /api/v2/projects/{projectId}/files/test

Tags: file

multipart/form-data


projectId	projectId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Serves icon of project

GET /api/v2/projects/{projectId}/icon

Tags: project

Serves icon stream in response body

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Rollbacks project job config of given type

DELETE /api/v2/projects/{projectId}/job-configs/{type}

Tags: project

application/json


projectId	projectId	path	integer (int64)
type	type	path	string , x ∈ { DEFAULT , INSTATEST , INTERACTIVE , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }

*/*

200 OK: OK

APIProjectJobConfig
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get project job config of given type

GET /api/v2/projects/{projectId}/job-configs/{type}

Tags: project

If no project specific config exists, returns global job config of given type.

application/json


projectId	projectId	path	integer (int64)
type	type	path	string , x ∈ { DEFAULT , INSTATEST , INTERACTIVE , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }

*/*

200 OK: OK

APIProjectJobConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Updates project job config of given type

POST /api/v2/projects/{projectId}/job-configs/{type}

Tags: project

application/json


projectId	projectId	path	integer (int64)
type	type	path	string , x ∈ { DEFAULT , INSTATEST , INTERACTIVE , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
content	content	query	string

*/*

200 OK: OK

APIProjectJobConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the notification email list of specified project

GET /api/v2/projects/{projectId}/notifications

Tags: user

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APINotificationEmail»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create the notification email of user

POST /api/v2/projects/{projectId}/notifications

Tags: user

application/json


projectId	projectId	path	integer (int64)
email	email	query	string
type	type	query	string , x ∈ { ALWAYS , ON_FAILURE }

*/*

201 Created: Created

APINotificationEmail
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get public device groups for project

GET /api/v2/projects/{projectId}/public-device-groups

Tags: device-group

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get summary report for project

GET /api/v2/projects/{projectId}/reports/summary

Tags: report

application/json


projectId	projectId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Run project for authenticated user using default project configuration

POST /api/v2/projects/{projectId}/runs

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
name	name	query	string
usedDeviceIds[]	deviceIds	query	integer[] , multiple parameters (`usedDeviceIds[]=aaa&usedDeviceIds[]=bbb`)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
gamebenchEnabled	gamebenchEnabled	query	boolean
videoRecordingEnabled	videoRecordingEnabled	query	boolean
timeout	timeout	query	integer (int64)
appFileId	appFileId	query	integer (int64)
testFileId	testFileId	query	integer (int64)
dataFileId	dataFileId	query	integer (int64)

*/*

201 Created: Created

APITestRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the test run list of user project

GET /api/v2/projects/{projectId}/runs-extended

Tags: test-run

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunExtended»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get extended test run from user project

GET /api/v2/projects/{projectId}/runs-extended/{runId}

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APITestRunExtended
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete test run from project

DELETE /api/v2/projects/{projectId}/runs/{runId}

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get test run from project

GET /api/v2/projects/{projectId}/runs/{runId}

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APITestRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update test run in project

POST /api/v2/projects/{projectId}/runs/{runId}

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
displayName	displayName	query	string

*/*

200 OK: OK

APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Abort test run from project, and receive partial results

POST /api/v2/projects/{projectId}/runs/{runId}/abort

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run config

GET /api/v2/projects/{projectId}/runs/{runId}/config

Tags: project

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APITestRunConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update test run config

POST /api/v2/projects/{projectId}/runs/{runId}/config

Tags: project

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
timeout	timeout	query	integer (int64)

*/*

200 OK: OK

APITestRunConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config parameters

GET /api/v2/projects/{projectId}/runs/{runId}/config/parameters

Tags: project

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunParameter»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config parameter

GET /api/v2/projects/{projectId}/runs/{runId}/config/parameters/{parameterId}

Tags: project

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

200 OK: OK

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run list of user test run

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get cluster build logs file

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/cluster-logs

Tags: device-runs

logs file as response body

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run data availability

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/data-availability

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run junit file

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/junit.xml

Tags: device-runs

junit file as response body

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run logs file

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/logs

Tags: device-runs

logs file as response body

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run performance file

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/performance

Tags: device-runs

performance file as response body

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run result data.zip

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/result-data.zip

Tags: device-runs

result data.zip as response body

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the screenshot list of device run

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIScreenshot»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get screenshot

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots/{screenshotId}

Tags: device-runs

screenshot file in response body

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)
screenshotId	screenshotId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state list of user device run

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRunState»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state of device run

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states/{stateId}

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)
stateId	stateId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRunState
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run steps

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/test-case-runs

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestCaseRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session list of user test run

GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSession»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get output files for device session by tag

GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
tag[]	tags	query	string[] , multiple parameters (`tag[]=aaa&tag[]=bbb`)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session output files.zip

GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files.zip

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session steps of device session

GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the current device session step of device session

GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/current

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session step of device session

GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
deviceSessionStepId	deviceSessionStepId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of files in user test run

GET /api/v2/projects/{projectId}/runs/{runId}/files

Tags: file

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIFiles
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get zip file with artifacts of user test run

GET /api/v2/projects/{projectId}/runs/{runId}/files.zip

Tags: file

zip stream is returned

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/projects/{projectId}/runs/{runId}/files/application

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/projects/{projectId}/runs/{runId}/files/application/check-results

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get data file in user project

GET /api/v2/projects/{projectId}/runs/{runId}/files/data

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test file in user project

GET /api/v2/projects/{projectId}/runs/{runId}/files/test

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get detail failures report for test run

GET /api/v2/projects/{projectId}/runs/{runId}/reports/detail-failures

Tags: report

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get failures report for test run

GET /api/v2/projects/{projectId}/runs/{runId}/reports/failures

Tags: report

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get summary report for test run

GET /api/v2/projects/{projectId}/runs/{runId}/reports/summary

Tags: report

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating apps and data zip from project

POST /api/v2/projects/{projectId}/runs/{testRunId}/apps-data.zip

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating build logs zip from project's test run

POST /api/v2/projects/{projectId}/runs/{testRunId}/build-logs.zip

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run data availability

GET /api/v2/projects/{projectId}/runs/{testRunId}/data-availability

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APITestRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating files zip from project

POST /api/v2/projects/{projectId}/runs/{testRunId}/files.zip

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating logs zip from project

POST /api/v2/projects/{projectId}/runs/{testRunId}/logs.zip

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating performance zip from project's test run

POST /api/v2/projects/{projectId}/runs/{testRunId}/performance.zip

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Retry test run or its device runs

POST /api/v2/projects/{projectId}/runs/{testRunId}/retry

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)
silently	silently	query	boolean

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating screenshot zip from project's test run

POST /api/v2/projects/{projectId}/runs/{testRunId}/screenshots.zip

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Start test run or its device runs

POST /api/v2/projects/{projectId}/runs/{testRunId}/start

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
usedDeviceIds[]	deviceIds	query	integer[] , multiple parameters (`usedDeviceIds[]=aaa&usedDeviceIds[]=bbb`)

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session steps of all device sessions in run

GET /api/v2/projects/{projectId}/runs/{testRunId}/steps

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run tag list from project test run

GET /api/v2/projects/{projectId}/runs/{testRunId}/tags

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APITag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add test run tag to test run

POST /api/v2/projects/{projectId}/runs/{testRunId}/tags

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
name	name	query	string

*/*

201 Created: Created

APITag
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete test run tag

DELETE /api/v2/projects/{projectId}/runs/{testRunId}/tags/{tagId}

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
tagId	tagId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get test run tag from test run

GET /api/v2/projects/{projectId}/runs/{testRunId}/tags/{tagId}

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
tagId	tagId	path	integer (int64)

*/*

200 OK: OK

APITag
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Unarchive project with specific ID

POST /api/v2/projects/{projectId}/unarchive

Tags: project

application/json


projectId	projectId	path	integer (int64)

*/*

201 Created: Created
204 No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the property list

GET /api/v2/properties

Tags: admin

application/json

*/*

200 OK: OK

APIAdminList«APIProperty»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create property

POST /api/v2/properties

Tags: admin

application/json


name	name	query	string
value	value	query	string
description	description	query	string
fromTime	fromTime	query	integer (int64)
toTime	toTime	query	integer (int64)

*/*

201 Created: Created

APIProperty
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create property banning application

POST /api/v2/properties/app-bans

Tags: admin

application/json


testRunId	testRunId	query	integer (int64)

*/*

201 Created: Created

APIProperty
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create property banning email domain

POST /api/v2/properties/email-bans

Tags: admin

application/json


email	email	query	string

*/*

201 Created: Created

APIProperty
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete property by id

DELETE /api/v2/properties/{id}

Tags: admin

application/json


id	propertyId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Update property

POST /api/v2/properties/{id}

Tags: admin

application/json


id	propertyId	path	integer (int64)
name	name	query	string
value	value	query	string
description	description	query	string
fromTime	fromTime	query	integer (int64)
toTime	toTime	query	integer (int64)
alwaysValid	alwaysValid	query	boolean

*/*

200 OK: OK

APIProperty
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the test run list

GET /api/v2/runs

Tags: test-run

application/json

*/*

200 OK: OK

APIList«APITestRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create Testrun

POST /api/v2/runs

Tags: test-run

application/json


projectId	projectId	query	integer (int64)
name	name	query	string

*/*

201 Created: Created

APITestRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete test run

DELETE /api/v2/runs/{runId}

Tags: test-run

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get test run

GET /api/v2/runs/{runId}

Tags: test-run

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APITestRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update test run name

POST /api/v2/runs/{runId}

Tags: test-run

application/json


runId	runId	path	integer (int64)
displayName	displayName	query	string
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Abort test run, and receive partial results

POST /api/v2/runs/{runId}/abort

Tags: test-run

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run config

GET /api/v2/runs/{runId}/config

Tags: project

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APITestRunConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update test run config

POST /api/v2/runs/{runId}/config

Tags: project

application/json


runId	testRunId	path	integer (int64)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
timeout	timeout	query	integer (int64)

*/*

200 OK: OK

APITestRunConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run config parameters

GET /api/v2/runs/{runId}/config/parameters

Tags: project

application/json


runId	runId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunParameter»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run config parameter

GET /api/v2/runs/{runId}/config/parameters/{parameterId}

Tags: project

application/json


runId	runId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

200 OK: OK

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run list of user test run

GET /api/v2/runs/{runId}/device-runs

Tags: device-runs

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get cluster build logs file

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/cluster-logs

Tags: device-runs

logs file as response body

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run data availability

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/data-availability

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run junit file

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/junit.xml

Tags: device-runs

junit file as response body

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run logs file

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/logs

Tags: device-runs

logs file as response body

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run performance file

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/performance

Tags: device-runs

performance file as response body

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run result data.zip

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/result-data.zip

Tags: device-runs

result data.zip as response body

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the screenshot list of device run

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/screenshots

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIScreenshot»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get screenshot

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/screenshots/{screenshotId}

Tags: device-runs

screenshot file in response body

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)
screenshotId	screenshotId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state list of the device run

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/states

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRunState»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state of device run

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/states/{stateId}

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)
stateId	stateId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRunState
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run steps

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/test-case-runs

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestCaseRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session list of user test run

GET /api/v2/runs/{runId}/device-sessions

Tags: device-session

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSession»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get output files for device session by tag

GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files

Tags: device-session

application/json


runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
tag[]	tags	query	string[] , multiple parameters (`tag[]=aaa&tag[]=bbb`)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session output files.zip

GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files.zip

Tags: device-session

application/json


runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session steps of device session

GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/steps

Tags: device-session

application/json


runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the current device session step of device session

GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/steps/current

Tags: device-session

application/json


runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session step of device session

GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}

Tags: device-session

application/json


runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
deviceSessionStepId	deviceSessionStepId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of files in user test run

GET /api/v2/runs/{runId}/files

Tags: file

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APIFiles
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get zip file with artifacts of user test run

GET /api/v2/runs/{runId}/files.zip

Tags: file

zip stream is returned

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/runs/{runId}/files/application

Tags: file

Returns file stream

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file check results

GET /api/v2/runs/{runId}/files/application/check-results

Tags: file

json stream returned

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get data file in user project

GET /api/v2/runs/{runId}/files/data

Tags: file

Returns file stream

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test file in user project

GET /api/v2/runs/{runId}/files/test

Tags: file

Returns file stream

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get detail failures report for test run

GET /api/v2/runs/{runId}/reports/detail-failures

Tags: report

application/json


runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get failures report for test run

GET /api/v2/runs/{runId}/reports/failures

Tags: report

application/json


runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get summary report for test run

GET /api/v2/runs/{runId}/reports/summary

Tags: report

application/json


runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating apps and data zip from test run

POST /api/v2/runs/{testRunId}/apps-data.zip

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
userId	userId	query	integer (int64)
projectId	projectId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating build logs zip from test run

POST /api/v2/runs/{testRunId}/build-logs.zip

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
userId	userId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run data availability

GET /api/v2/runs/{testRunId}/data-availability

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
userId	userId	query	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APITestRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating files zip from test run

POST /api/v2/runs/{testRunId}/files.zip

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
userId	userId	query	integer (int64)
projectId	projectId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating logs zip from test run

POST /api/v2/runs/{testRunId}/logs.zip

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
userId	userId	query	integer (int64)
projectId	projectId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating performance zip from test run

POST /api/v2/runs/{testRunId}/performance.zip

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
userId	userId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Retry test run or its device runs

POST /api/v2/runs/{testRunId}/retry

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)
silently	silently	query	boolean

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating screenshot zip from test run

POST /api/v2/runs/{testRunId}/screenshots.zip

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
userId	userId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Start test run or its device runs

POST /api/v2/runs/{testRunId}/start

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
usedDeviceIds[]	deviceIds	query	integer[] , multiple parameters (`usedDeviceIds[]=aaa&usedDeviceIds[]=bbb`)

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session steps of all device sessions in run

GET /api/v2/runs/{testRunId}/steps

Tags: device-session

application/json


testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get tag list from test run

GET /api/v2/runs/{testRunId}/tags

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APIList«APITag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add tag to test run

POST /api/v2/runs/{testRunId}/tags

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
name	name	query	string
projectId	projectId	query	integer (int64)

*/*

201 Created: Created

APITag
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete test run tag

DELETE /api/v2/runs/{testRunId}/tags/{tagId}

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
tagId	tagId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get test run tag from user's test run

GET /api/v2/runs/{testRunId}/tags/{tagId}

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
tagId	tagId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APITag
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Buy service

POST /api/v2/services

Tags: account-service

For not logged in users

application/json


serviceId	serviceId	query	integer (int64)
name	name	query	string
email	email	query	string
phone	phone	query	string
organization	organization	query	string
vat-id	vatId	query	string
country	country	query	string
city	city	query	string
state	state	query	string
address	address	query	string
zip	zip	query	string
paymentMethod	paymentMethod	query	string , x ∈ { PAYPAL , BRAINTREE , INVOICE , PROMOTION }
cardNumber	cardNumber	query	string
expirationDate	expirationDate	query	string
cvv	cvv	query	string
feedback	feedback	query	string

*/*

201 Created: Created

APIServicePaymentStatus
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all available services for any user

GET /api/v2/services/available

Tags: account-service

For not logged in users

application/json

*/*

200 OK: OK

APIList«APIService»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the session list

GET /api/v2/sessions

Tags: admin

ignores sort, orders by loginTime desc by default

application/json

*/*

200 OK: OK

APIAdminList«APISession»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create session (login)

POST /api/v2/sessions

Tags: admin

application/json


ip	ip	query	string
id	sessionId	query	string

*/*

201 Created: Created

APISession
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get session with specific ID

GET /api/v2/sessions/{id}

Tags: admin

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APISession
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Close session (logout)

POST /api/v2/sessions/{id}

Tags: admin

application/json


id	id	path	integer (int64)

*/*

200 OK: APISession
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all users (restricted by offset, limit, search phrase and order)

GET /api/v2/users

Tags: user

For ADMIN only

application/json

*/*

200 OK: OK

APIList«APIUser»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

POST /api/v2/users

Tags: user

application/json


email	email	query	string

*/*

201 Created: Created

APIUser
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Activate user after registration

POST /api/v2/users/activate

Tags: user

application/json


email	email	query	string
key	key	query	string
password	password	query	string
name	name	query	string
phone	phone	query	string
organization	organization	query	string
role	organizationRole	query	string , x ∈ { CEO_OR_OWNER , VP , MANAGER , INDIVIDUAL , QUALITY_ASSURANCE , DEVELOPER , MARKETING , CONSULTANT , OTHER }
hearFrom	hearFrom	query	string , x ∈ { COWORKER , EMAIL_CAMPAIGN , EVENT , ONLINE_COMMUNITY , SOCIAL_NETWORK , WEB_SEARCH , OTHER }
country	country	query	string
city	city	query	string
state	state	query	string
address	address	query	string
zip	zip	query	string
vat-id	vatId	query	string

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Set new password after recovery

POST /api/v2/users/password-recovery

Tags: user

application/json


key	key	query	string
password	password	query	string

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get user by recovery key

GET /api/v2/users/recoveries

Tags: user

application/json


recoveryKey	recoveryKey	query	string

*/*

200 OK: OK

APIUser
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Generate recovery key for user

POST /api/v2/users/recoveries

Tags: user

application/json


email	email	query	string

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Check if activation or password reset link is valid

GET /api/v2/users/validate-activation

Tags: user

application/json


key	key	query	string

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Is EU VAT ID correct

GET /api/v2/users/validateVatId

Tags: user

application/json


countryCode	countryCode	query	string
vatId	vatId	query	string

*/*

200 OK: OK

string
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get user with specific ID

GET /api/v2/users/{id}

Tags: user

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APIUser
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update user with specific ID

POST /api/v2/users/{id}

Tags: user

application/json


id	id	path	integer (int64)
name	name	query	string
localeCountry	localeCountry	query	string
timeZone	timeZone	query	string
email	email	query	string
code	code	query	string
state	state	query	string
city	city	query	string
address	address	query	string
phone	phone	query	string
organization	organization	query	string
vatID	vatID	query	string
emailNotification	emailNotification	query	string , x ∈ { ALWAYS , NEVER , ON_FAILURE }
newPassword	newPassword	query	string
confirmPassword	confirmPassword	query	string

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project types available for user

GET /api/v2/users/{id}/available-project-types

Tags: user

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APIArray«string»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device group list of user with specific ID

GET /api/v2/users/{id}/device-groups

Tags: device-group

application/json


id	userId	path	integer (int64)
withPublic	withPublic	query	boolean

*/*

200 OK: OK

APIList«APIDeviceGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create device group for user

POST /api/v2/users/{id}/device-groups

Tags: device-group

application/json


id	userId	path	integer (int64)
name	name	query	string
osType	osType	query	string , x ∈ { IOS , ANDROID , UNDEFINED }

*/*

201 Created: Created

APIDeviceGroup
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device time history for user

GET /api/v2/users/{id}/device-time

Tags: account-service

application/json


id	userId	path	integer (int64)
withAdditionalUsers	withAdditionalUsers	query	boolean

*/*

200 OK: OK

APIUserDeviceTime
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get reserved(status is WAITING or RUNNING) device time by user

GET /api/v2/users/{id}/device-time/reserved

Tags: account-service

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIBasicDeviceTime
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get used(status is SUCCEEDED or FAILED) device time by user

GET /api/v2/users/{id}/device-time/used

Tags: account-service

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIBasicDeviceTime
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the project list of user with specific ID

GET /api/v2/users/{id}/projects

Tags: project

Owned projects + shared projects + public projects

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIProject»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create project for authenticated user

POST /api/v2/users/{id}/projects

Tags: project

application/json


id	userId	path	integer (int64)
name	name	query	string
type	type	query	string , x ∈ { ANDROID , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }

*/*

201 Created: Created

APIProject
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Run project for authenticated user using default project configuration

POST /api/v2/users/{id}/projects/{projectId}/runs

Tags: test-run

application/json


id	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
name	name	query	string
usedDeviceIds[]	deviceIds	query	integer[] , multiple parameters (`usedDeviceIds[]=aaa&usedDeviceIds[]=bbb`)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
gamebenchEnabled	gamebenchEnabled	query	boolean
videoRecordingEnabled	videoRecordingEnabled	query	boolean
timeout	timeout	query	integer (int64)
appFileId	appFileId	query	integer (int64)
testFileId	testFileId	query	integer (int64)
dataFileId	dataFileId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

201 Created: Created

APITestRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Reset api key

POST /api/v2/users/{id}/reset-api-key

Tags: user

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete all test runs of user with specific ID

DELETE /api/v2/users/{id}/runs

Tags: user

application/json


id	userId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the test run list of authenticated user

GET /api/v2/users/{id}/runs

Tags: test-run

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all active services for selected user

GET /api/v2/users/{id}/services/active

Tags: account-service

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIAccountService»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all available services for selected user

GET /api/v2/users/{id}/services/available

Tags: account-service

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIService»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all purchased services by user

GET /api/v2/users/{id}/services/purchased

Tags: account-service

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIAccountService»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Cancel service subscription

DELETE /api/v2/users/{id}/services/{serviceId}

Tags: account-service

application/json


id	userId	path	integer (int64)
serviceId	serviceId	path	integer (int64)

*/*

200 OK: OK

APIServicePaymentStatus
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get account

GET /api/v2/users/{userId}/account

Tags: account

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIAccount
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get billing information for billing period given by date

GET /api/v2/users/{userId}/account-services/{accountServiceId}/billing-period

Tags: account-service

application/json


userId	userId	path	integer (int64)
accountServiceId	accountServiceId	path	integer (int64)
onDate	timestamp	query	integer (int64)

*/*

200 OK: OK

APIAccountServicePayment
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get additional users

GET /api/v2/users/{userId}/account/additional-users

Tags: user

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUser»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add additional user

POST /api/v2/users/{userId}/account/additional-users

Tags: user

application/json


userId	userId	path	integer (int64)
email	email	query	string
password	password	query	string

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Disable additional user

DELETE /api/v2/users/{userId}/account/additional-users/{additionalUserId}

Tags: user

application/json


userId	userId	path	integer (int64)
additionalUserId	additionalUserId	path	integer (int64)

*/*

200 OK: OK

APIUser
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Enable additional user

POST /api/v2/users/{userId}/account/additional-users/{additionalUserId}

Tags: user

application/json


userId	userId	path	integer (int64)
additionalUserId	additionalUserId	path	integer (int64)

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get users billing periods

GET /api/v2/users/{userId}/billing-periods

Tags: account-service

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIBillingPeriod»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get billing period

GET /api/v2/users/{userId}/billing-periods/{billingPeriodId}

Tags: account-service

application/json


userId	userId	path	integer (int64)
billingPeriodId	billingPeriodId	path	integer (int64)

*/*

200 OK: OK

APIBillingPeriod
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get purchased service receipt

GET /api/v2/users/{userId}/billing-periods/{billingPeriodId}/receipt

Tags: account-service

application/json


userId	userId	path	integer (int64)
billingPeriodId	billingPeriodId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete the device group of user with specific ID

DELETE /api/v2/users/{userId}/device-groups/{deviceGroupId}

Tags: device-group

application/json


userId	userId	path	integer (int64)
deviceGroupId	deviceGroupId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the device group of user with specific ID

GET /api/v2/users/{userId}/device-groups/{deviceGroupId}

Tags: device-group

application/json


userId	userId	path	integer (int64)
deviceGroupId	deviceGroupId	path	integer (int64)

*/*

200 OK: OK

APIDeviceGroup
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update the device group of user with specific ID

POST /api/v2/users/{userId}/device-groups/{deviceGroupId}

Tags: device-group

application/json


userId	userId	path	integer (int64)
deviceGroupId	deviceGroupId	path	integer (int64)
name	name	query	string
osType	osType	query	string , x ∈ { IOS , ANDROID , UNDEFINED }

*/*

200 OK: APIDeviceGroup
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device list of user device group

GET /api/v2/users/{userId}/device-groups/{deviceGroupId}/devices

Tags: device-group

application/json


userId	userId	path	integer (int64)
deviceGroupId	deviceGroupId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDevice»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add device to device group

POST /api/v2/users/{userId}/device-groups/{deviceGroupId}/devices

Tags: device-group

application/json


userId	userId	path	integer (int64)
deviceGroupId	deviceGroupId	path	integer (int64)
deviceId	deviceModelId	query	integer (int64)

*/*

201 Created: Created

APIDeviceGroup
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete device from device group

DELETE /api/v2/users/{userId}/device-groups/{deviceGroupId}/devices/{deviceId}

Tags: device-group

application/json


userId	userId	path	integer (int64)
deviceGroupId	deviceGroupId	path	integer (int64)
deviceId	deviceModelId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get Inspector device sessions

GET /api/v2/users/{userId}/device-sessions

Tags: device-session

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSession»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create Inspector device session

POST /api/v2/users/{userId}/device-sessions

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceModelId	deviceModelId	query	integer (int64)
fileSetId	fileSetId	query	integer (int64)
url	url	query	string
timeout	timeout	query	integer (int64)

*/*

201 Created: Created

APIDeviceSession
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session output files.zip

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/files.zip

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get notes for device session

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add note to device session

POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes

Tags: device-session

Note is stored as APIUserFile within output file set

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
name	name	query	string
content	content	query	string

*/*

201 Created: Created

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete note from device session

DELETE /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
fileNoteId	fileNoteId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get note for device session

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
fileNoteId	fileNoteId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update note for device session

POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
fileNoteId	fileNoteId	path	integer (int64)
name	name	query	string
content	content	query	string

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download note for device session

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}/file

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
fileNoteId	fileNoteId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get screenshots for device session

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add screenshot to device session

POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots

Tags: device-session

Screenshot is stored as APIUserFile within output file set.

multipart/form-data


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
name	name	query	string
screenshot	screenshot	formData	file

*/*

201 Created: Created

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating screenshot zip from user's Interactive device session

POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/screenshots.zip

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get screenshot for device session

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/{screenshotFileId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
screenshotFileId	screenshotFileId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download screenshot for device session

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/{screenshotFileId}/file

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
screenshotFileId	screenshotFileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete screenshot from device session

DELETE /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/{screenshotId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
screenshotId	screenshotId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Releases users device session

POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/release

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSession
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get Inspector device session

GET /api/v2/users/{userId}/device-sessions/{sessionId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
sessionId	sessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSession
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get connections for Inspector device session

GET /api/v2/users/{userId}/device-sessions/{sessionId}/connections

Tags: device-session

application/json


userId	userId	path	integer (int64)
sessionId	sessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIConnection»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create connection for device session

POST /api/v2/users/{userId}/device-sessions/{sessionId}/connections

Tags: device-session

application/json


userId	userId	path	integer (int64)
sessionId	sessionId	path	integer (int64)
host	host	query	string
port	port	query	integer (int32)
type	type	query	string
password	password	query	string

*/*

201 Created: Created

APIConnection
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get connection for Inspector device session

GET /api/v2/users/{userId}/device-sessions/{sessionId}/connections/{connectionId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
sessionId	sessionId	path	integer (int64)
connectionId	connectionId	path	integer (int64)

*/*

200 OK: OK

APIConnection
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create feedback email from user

POST /api/v2/users/{userId}/feedback

Tags: user

multipart/form-data


userId	userId	path	integer (int64)
content	content	query	string
file	file	formData	file

*/*

201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file set list of user with specific ID

GET /api/v2/users/{userId}/file-sets

Tags: file

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIFileSet»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create file set for user

POST /api/v2/users/{userId}/file-sets

Tags: file

application/json


userId	userId	path	integer (int64)
name	name	query	string

*/*

201 Created: Created

APIFileSet
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete the file set of user with specific ID

DELETE /api/v2/users/{userId}/file-sets/{fileSetId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the file set of user with specific ID

GET /api/v2/users/{userId}/file-sets/{fileSetId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)

*/*

200 OK: OK

APIFileSet
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update the file set of user with specific ID

POST /api/v2/users/{userId}/file-sets/{fileSetId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
name	name	query	string

*/*

200 OK: APIFileSet
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get file list of user file set

GET /api/v2/users/{userId}/file-sets/{fileSetId}/files

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add file to file set

POST /api/v2/users/{userId}/file-sets/{fileSetId}/files

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	query	integer (int64)

*/*

200 OK: APIFileSet
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete file from file set

DELETE /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: APIFileSet
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get user file with specific ID

GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update file name with specific id

POST /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)
name	name	query	string

*/*

200 OK: APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download file from file set

GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}/file

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download icon of file from file set

GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}/icon

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file tags list

GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}/tags

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFileTag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file list of user with specific ID

GET /api/v2/users/{userId}/files

Tags: file

Owned files

application/json


userId	userId	path	integer (int64)
tag[]	tags	query	string[] , multiple parameters (`tag[]=aaa&tag[]=bbb`)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload file for authenticated user

POST /api/v2/users/{userId}/files

Tags: file

multipart/form-data


userId	userId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete file with specific ID

DELETE /api/v2/users/{userId}/files/{fileId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get user file with specific ID

GET /api/v2/users/{userId}/files/{fileId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update file name with specific id

POST /api/v2/users/{userId}/files/{fileId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileId	fileId	path	integer (int64)
name	name	query	string

*/*

200 OK: APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download file

GET /api/v2/users/{userId}/files/{fileId}/file

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download icon of file

GET /api/v2/users/{userId}/files/{fileId}/icon

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file tags list

GET /api/v2/users/{userId}/files/{fileId}/tags

Tags: file

application/json


userId	userId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFileTag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get jira account for user with userId

GET /api/v2/users/{userId}/jira-account

Tags: jira

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIJiraAccount
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create jira account for user with userId

POST /api/v2/users/{userId}/jira-account

Tags: jira

application/json


userId	userId	path	integer (int64)
username	username	query	string
password	password	query	string
jiraUrl	jiraUrl	query	string

*/*

201 Created: Created

APIJiraAccount
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete jira account with specified jiraAccountId

DELETE /api/v2/users/{userId}/jira-account/{jiraAccountId}

Tags: jira

application/json


userId	userId	path	integer (int64)
jiraAccountId	jiraAccountId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get jira account with specified jiraAccountId

GET /api/v2/users/{userId}/jira-account/{jiraAccountId}

Tags: jira

application/json


userId	userId	path	integer (int64)
jiraAccountId	jiraAccountId	path	integer (int64)

*/*

200 OK: OK

APIJiraAccount
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update jira account with specified jiraAccountId

POST /api/v2/users/{userId}/jira-account/{jiraAccountId}

Tags: jira

application/json


userId	userId	path	integer (int64)
jiraAccountId	jiraAccountId	path	integer (int64)
username	username	query	string
password	password	query	string
jiraUrl	jiraUrl	query	string

*/*

200 OK: APIJiraAccount
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update jira account certificate with specified jiraAccountId

POST /api/v2/users/{userId}/jira-account/{jiraAccountId}/certificate

Tags: jira

multipart/form-data


userId	userId	path	integer (int64)
jiraAccountId	jiraAccountId	path	integer (int64)
jiraCert	jiraCert	formData	file

*/*

200 OK: APIJiraAccount
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Log user activity

POST /api/v2/users/{userId}/log-activity

Tags: user

application/json


userId	userId	path	integer (int64)
applicationType	applicationType	query	string , x ∈ { RECORDER }
eventType	eventType	query	string , x ∈ { RECORDER_OPEN_WIZARD , RECORDER_RUN_IN_CLOUD , RECORDER_FINISH_WIZARD , RECORDER_RUN_APPCRAWLER }

*/*

200 OK: OK

APIEvent
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the notification email list of user with specific id

GET /api/v2/users/{userId}/notifications

Tags: user

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APINotificationEmail»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create the notification email of user

POST /api/v2/users/{userId}/notifications

Tags: user

application/json


userId	userId	path	integer (int64)
email	email	query	string
type	type	query	string , x ∈ { ALWAYS , ON_FAILURE }

*/*

201 Created: Created

APINotificationEmail
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete the notification email of user with specific ID

DELETE /api/v2/users/{userId}/notifications/{id}

Tags: user

application/json


userId	userId	path	integer (int64)
id	id	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the notification email of user with specific ID

GET /api/v2/users/{userId}/notifications/{id}

Tags: user

application/json


userId	userId	path	integer (int64)
id	id	path	integer (int64)

*/*

200 OK: OK

APINotificationEmail
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update the notification email of user with specific ID

POST /api/v2/users/{userId}/notifications/{id}

Tags: user

application/json


userId	userId	path	integer (int64)
id	id	path	integer (int64)
type	type	query	string , x ∈ { ALWAYS , ON_FAILURE }

*/*

200 OK: OK

APINotificationEmail
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete user project with specific ID

DELETE /api/v2/users/{userId}/projects/{projectId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get user project with specific ID

GET /api/v2/users/{userId}/projects/{projectId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIProject
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update user project with specific id

POST /api/v2/users/{userId}/projects/{projectId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
name	name	query	string
description	description	query	string
common	common	query	boolean
archivingStrategy	archivingStrategy	query	string , x ∈ { NEVER , DAYS , RUNS }
archivingItemCount	archivingItemCount	query	integer (int32)

*/*

200 OK: APIProject
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config

GET /api/v2/users/{userId}/projects/{projectId}/config

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APITestRunConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update project test run config

POST /api/v2/users/{userId}/projects/{projectId}/config

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
gamebenchEnabled	gamebenchEnabled	query	boolean
videoRecordingEnabled	videoRecordingEnabled	query	boolean
timeout	timeout	query	integer (int64)

*/*

200 OK: OK

APITestRunConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config parameters

GET /api/v2/users/{userId}/projects/{projectId}/config/parameters

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunParameter»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add project test run config parameters

POST /api/v2/users/{userId}/projects/{projectId}/config/parameters

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
key	key	query	string
value	value	query	string

*/*

201 Created: Created

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete project test run config parameter

DELETE /api/v2/users/{userId}/projects/{projectId}/config/parameters/{parameterId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get project test run config parameter

GET /api/v2/users/{userId}/projects/{projectId}/config/parameters/{parameterId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

200 OK: OK

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of available device groups for project

GET /api/v2/users/{userId}/projects/{projectId}/device-groups

Tags: project

Serves icon stream in response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of files in user project

GET /api/v2/users/{userId}/projects/{projectId}/files

Tags: file

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIFiles
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get zip file with artifacts of user project

GET /api/v2/users/{userId}/projects/{projectId}/files.zip

Tags: file

zip stream is returned

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/users/{userId}/projects/{projectId}/files/application

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload application file in user project

POST /api/v2/users/{userId}/projects/{projectId}/files/application

Tags: file

multipart/form-data


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get data file in user project

GET /api/v2/users/{userId}/projects/{projectId}/files/data

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload data file in user project

POST /api/v2/users/{userId}/projects/{projectId}/files/data

Tags: file

multipart/form-data


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test file in user project

GET /api/v2/users/{userId}/projects/{projectId}/files/test

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload test file in user project

POST /api/v2/users/{userId}/projects/{projectId}/files/test

Tags: file

multipart/form-data


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Serves icon of user project

GET /api/v2/users/{userId}/projects/{projectId}/icon

Tags: project

Serves icon stream in response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the notification email list of user with specific id for specified project

GET /api/v2/users/{userId}/projects/{projectId}/notifications

Tags: user

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APINotificationEmail»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create the notification email of user

POST /api/v2/users/{userId}/projects/{projectId}/notifications

Tags: user

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
email	email	query	string
type	type	query	string , x ∈ { ALWAYS , ON_FAILURE }

*/*

201 Created: Created

APINotificationEmail
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get public device groups for project

GET /api/v2/users/{userId}/projects/{projectId}/public-device-groups

Tags: device-group

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get summary report for project

GET /api/v2/users/{userId}/projects/{projectId}/reports/summary

Tags: report

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the test run list of user project

GET /api/v2/users/{userId}/projects/{projectId}/runs

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the test run list of user project

GET /api/v2/users/{userId}/projects/{projectId}/runs-extended

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunExtended»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get extended test run from user project

GET /api/v2/users/{userId}/projects/{projectId}/runs-extended/{runId}

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APITestRunExtended
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete test run from user's project

DELETE /api/v2/users/{userId}/projects/{projectId}/runs/{runId}

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get test run from user's project

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APITestRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update test run in user's project

POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
displayName	displayName	query	string

*/*

200 OK: OK

APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Abort test run from user's project, and receive partial results

POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/abort

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get user test run config

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APITestRunConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update test run config

POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
timeout	timeout	query	integer (int64)

*/*

200 OK: OK

APITestRunConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config parameters

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunParameter»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add project test run config parameters

POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
key	key	query	string
value	value	query	string

*/*

201 Created: Created

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete project test run config parameter

DELETE /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters/{parameterId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get project test run config parameter

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters/{parameterId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

200 OK: OK

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run list of user test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the user device run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the user cluster build logs file

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/cluster-logs

Tags: device-runs

cluster build logs file as response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run data availability

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/data-availability

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the user device run junit file

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/junit.xml

Tags: device-runs

junit file as response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the user device run logs file

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/logs

Tags: device-runs

logs file as response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the user device run performance file

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/performance

Tags: device-runs

performance file as response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the user device run result data file

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/result-data.zip

Tags: device-runs

result data.zip as response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the screenshot list of user device run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIScreenshot»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get user screenshot

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots/{screenshotId}

Tags: device-runs

screenshot file in response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)
screenshotId	screenshotId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state list of the device run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRunState»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state of user device run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states/{stateId}

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)
stateId	stepId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRunState
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run steps

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/test-case-runs

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestCaseRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session list of user test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSession»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get output files for device session by tag

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
tag[]	tags	query	string[] , multiple parameters (`tag[]=aaa&tag[]=bbb`)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session output files.zip

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files.zip

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session steps of device session

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the current device session step of device session

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/current

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session step of device session

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
deviceSessionStepId	deviceSessionStepId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of files in user test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files

Tags: file

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIFiles
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get zip file with artifacts of user test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files.zip

Tags: file

zip stream is returned

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/application

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/application/check-results

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get data file in user project

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/data

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test file in user project

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/test

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get cucumber test run report for calabash project

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/cucumber

Tags: report

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	query	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get detail failures report for test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/detail-failures

Tags: report

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get failures report for test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/failures

Tags: report

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get summary report for test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/summary

Tags: report

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating apps and data zip from user's test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/apps-data.zip

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run data availability

GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/data-availability

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APITestRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating files zip from user's test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/files.zip

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating logs zip from user's test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/logs.zip

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating performance zip from user's test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/performance.zip

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Retry test run or its device runs

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/retry

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)
silently	silently	query	boolean

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating screenshot zip from user's test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/screenshots.zip

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Start test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/start

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
usedDeviceIds[]	deviceIds	query	integer[] , multiple parameters (`usedDeviceIds[]=aaa&usedDeviceIds[]=bbb`)

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session steps of all device sessions in run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/steps

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run tag list from user's test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APITag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add test run tag to user's test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
name	name	query	string

*/*

201 Created: Created

APITag
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete test run tag from user's test run

DELETE /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags/{tagId}

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
tagId	tagId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get test run tag from user's test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags/{tagId}

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
tagId	tagId	path	integer (int64)

*/*

200 OK: OK

APITag
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project sharings of user specified by ID

GET /api/v2/users/{userId}/projects/{projectId}/sharings

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APIProjectSharing»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Share project to specified by email

POST /api/v2/users/{userId}/projects/{projectId}/sharings

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
email	email	query	string

*/*

201 Created: Created

APIProjectSharing
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete project sharing of user specified by ID

DELETE /api/v2/users/{userId}/projects/{projectId}/sharings/{sharingId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
sharingId	sharingId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get project sharing of user specified by ID

GET /api/v2/users/{userId}/projects/{projectId}/sharings/{sharingId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
sharingId	sharingId	path	integer (int64)

*/*

200 OK: OK

APIProjectSharing
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get receipt for users service

GET /api/v2/users/{userId}/receipts

Tags: user

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIAccountService»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Buy service

POST /api/v2/users/{userId}/services

Tags: account-service

application/json


userId	userId	path	integer (int64)
serviceId	serviceId	query	integer (int64)
name	name	query	string
email	email	query	string
phone	phone	query	string
organization	organization	query	string
vat-id	vatId	query	string
country	country	query	string
city	city	query	string
state	state	query	string
address	address	query	string
zip	zip	query	string
paymentMethod	paymentMethod	query	string , x ∈ { PAYPAL , BRAINTREE , INVOICE , PROMOTION }
cardNumber	cardNumber	query	string
expirationDate	expirationDate	query	string
cvv	cvv	query	string
feedback	feedback	query	string

*/*

201 Created: Created

APIServicePaymentStatus
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Load user ui preferences

GET /api/v2/users/{userId}/ui-preferences

Tags: user

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Store user ui preferences

POST /api/v2/users/{userId}/ui-preferences

Tags: user

application/json


userId	userId	path	integer (int64)
data	data	query	string

*/*

200 OK: OK
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Schema definitions

Account: object

accountRoles: object[]: AccountRole
accountServices: object[]: AccountService
createTime: string (date-time)
id: integer (int64)
lastBilledAccountService: AccountService
maxTimeout: integer (int32)
testScreenshotLimit: integer (int32)
users: object[]: User

AccountRole: object

accountService: AccountService
active: boolean
createTime: string (date-time)
expireTime: string (date-time)
id: integer (int64)
name: string
role: Role
startTime: string (date-time)

AccountService: object

active: boolean
autoRenew: boolean
billingPeriods: object[]: BillingPeriod
createTime: LocalDateTime
deactivateReason: string , x ∈ { INITIAL_FAILURE , CHARGE_FAILURE , CANCEL }
endTime: LocalDateTime
finished: boolean
id: integer (int64)
lastBillingTime: LocalDateTime
lastPaymentTime: LocalDateTime
nextBillingTime: LocalDateTime
payUnitCount: integer (int32)
payUnitText: string
paymentMethod: string , x ∈ { PAYPAL , BRAINTREE , INVOICE , PROMOTION }
paymentState: string , x ∈ { CREATED , ACTIVATED , FIRST_SUBSCRIPTION_NOT_CHARGED , RUN , WAITING_FOR_ADDITIONAL_HOURS_PAYMENT , SUBSCRIPTION_NOT_CHARGED , SUBSCRIPTION_CHARGED , CANCELED }
rolesIncluded: object[]: AccountRole
serviceCount: integer (int32)
serviceId: integer (int64)
startTime: LocalDateTime
total: integer (int32)
totalString: string
unit: string , x ∈ { MONTH , DAY , YEAR , HOUR , RUN , PROJECT }
unitCount: integer (int32)
vat: integer (int32)
vatRate: integer (int32)

AndroidLicense: object

cts: CTSLicense
deviceLimit: integer (int32)
deviceLimited: boolean
enabled: boolean
projectLimit: integer (int32)
projectLimited: boolean
uiAutomator: UIAutomatorLicense

APIAccount: object

createTime: string (date-time)
id: integer (int64)
mainUserEmail: string
mainUserName: string
maxTimeout: integer (int32)
testScreenshotLimit: integer (int32)

APIAccountService: object

accountId: integer (int64)
activatedById: integer (int64)
activatedByName: string
active: boolean
autoRenew: boolean
braintreeId: string
createTime: string (date-time)
deactivateReason: string , x ∈ { INITIAL_FAILURE , CHARGE_FAILURE , CANCEL }
deactivatedById: integer (int64)
deactivatedByName: string
endTime: string (date-time)
finished: boolean
id: integer (int64)
lastPaymentTime: string (date-time)
paymentMethod: string , x ∈ { PAYPAL , BRAINTREE , INVOICE , PROMOTION }
price: integer (int32)
serviceCount: integer (int32)
serviceId: integer (int64)
serviceName: string
startTime: string (date-time)
total: integer (int32)
unit: string , x ∈ { MONTH , DAY , YEAR , HOUR , RUN , PROJECT }
unitCount: integer (int32)
userEmail: string
userId: integer (int64)
vatRate: integer (int32)

APIAccountServicePayment: object

accountId: integer (int64)
additionalTime: integer (int64)
endBillingPeriod: string (date-time)
id: integer (int64)
includedTime: integer (int64)
name: string
startBillingPeriod: string (date-time)
totalPrice: integer (int64)
usedTime: integer (int64)

APIActiveUser: object

country: string
email: string
id: integer (int64)
loginTime: string (date-time)
organization: string
priority: integer (int32)
timeZone: string

APIAdminDevice: object

deviceModelId: integer (int64)
enabled: boolean
fingerprint: string
id: integer (int64)
initStep: string , x ∈ { SKIP , REBOOT , REBOOT_WITH_UNLOCK , UNLOCK_ONLY }
name: string
queue: APIList«APIDeviceRun»
serialId: string
softwareVersion: APISoftwareVersion
state: string , x ∈ { ONLINE , OFFLINE }
stateTime: string (date-time)
unlockGesture: string

APIAdminDeviceModel: object

avgWaitingTime: integer (int64)
enabled: boolean
id: integer (int64)
name: string
online: integer (int32)
queueSize: integer (int32)
running: integer (int32)
total: integer (int32)
vncSupported: boolean

APIAdminDeviceProblem: object

clusterId: integer (int64)
clusterName: string
deviceId: integer (int64)
deviceName: string
id: integer (int64)
problems: object[]: APIAdminDeviceProblemPair

APIAdminDeviceProblemPair: object

id: integer (int64)
type: string , x ∈ { OFFLINE , LOW_BATTERY , HIGH_FAIL_RATE , NO_INTERNET_CONNECTION }
value: object

APIAdminDeviceSession: object

billable: boolean
endTime: string (date-time)
errorMessage: string
id: integer (int64)
priority: integer (int32)
projectId: integer (int64)
projectName: string
startTime: string (date-time)
startedByDisplayName: string
state: string , x ∈ { WAITING , RUNNING , EXCLUDED , WARNING , FAILED , SUCCEEDED }
testRunId: integer (int64)
testRunName: string

APIAdminDeviceType: object

frameExtraWidth: integer (int32)
id: integer (int64)
imageHeight: integer (int32)
imageLeft: integer (int32)
imagePrefix: string
imageTop: integer (int32)
imageWidth: integer (int32)

APIAdminError: object

id: integer (int64)
quantity: integer (int64)
type: string , x ∈ { DEVICE_OFFLINE , NO_NETWORK_CONNECTION , REBOOTING_TIMEOUT , REPACKAGING , INSTALL_FAILED , INTERNAL_INSTALL_FAILED , ADB_COMMAND_REJECTED , ADB_SHELL_COMMAND_FAILED , XCRUN_INSTRUMENTS_COMMAND_FAILED , XCRUN_INSTRUMENTS_JS_ERROR , TEST_RUN_INTERRUPTED , TEST_RUN_TIMEOUT , TEST_RUN_FAILED , RESULTS_PROCESSING , INVALID_TEST_SESSION_FILE , LOCK_TIMEOUT , LOCK_EXPIRED , STEP_TIMEOUT , TEST_TIMEOUT , GRANT_FAILED , GAMEBENCH_NOT_SUPPORTED , GAMEBENCH_ERROR , APP_LOCK_NOT_INSTALLED , DEVICE_OUTPUT_NULL , SYSTEM_FAILURE , INTERACTIVE_SETUP_FAILED , OTHER }

APIAdminInteractiveDeviceSession: object

billable: boolean
deviceId: integer (int64)
deviceModelId: integer (int64)
deviceModelName: string
deviceName: string
duration: integer (int64)
endTime: string (date-time)
errorMessage: string
id: integer (int64)
startTime: string (date-time)
state: string , x ∈ { WAITING , RUNNING , EXCLUDED , WARNING , FAILED , SUCCEEDED }
userEmail: string
userId: integer (int64)

APIAdminList«APIAccount»: object

data: object[]: APIAccount
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APIActiveUser»: object

data: object[]: APIActiveUser
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APIAdminDeviceModel»: object

data: object[]: APIAdminDeviceModel
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APIAdminDeviceProblem»: object

data: object[]: APIAdminDeviceProblem
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APIAdminDeviceSession»: object

data: object[]: APIAdminDeviceSession
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APIAdminDeviceType»: object

data: object[]: APIAdminDeviceType
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APIAdminDevice»: object

data: object[]: APIAdminDevice
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APIAdminError»: object

data: object[]: APIAdminError
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APIAdminInteractiveDeviceSession»: object

data: object[]: APIAdminInteractiveDeviceSession
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APIAdminTestRun»: object

data: object[]: APIAdminTestRun
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APICluster»: object

data: object[]: APICluster
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APIDeviceStatus»: object

data: object[]: APIDeviceStatus
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APIProperty»: object

data: object[]: APIProperty
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminList«APISession»: object

data: object[]: APISession
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIAdminOverview: object

activeUsersCount: integer (int64)
id: integer (int64)
inspectorSessionsCount: integer (int64)
runningDeviceModelsCount: integer (int64)
runningTestRunsCount: integer (int64)
waitingDeviceModelsCount: integer (int64)
waitingTestRunsCount: integer (int64)

APIAdminTestRun: object

createTime: string (date-time)
endTime: string (date-time)
id: integer (int64)
mode: string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
priority: integer (int32)
projectId: integer (int64)
projectName: string
startTime: string (date-time)
successRatio: number (float)
testRunName: string
userName: string

APIArray«string»: object

id: integer (int64)
items: string[]: string

APIBasicDeviceTime: object

deviceTime: integer (int64)
id: integer (int64)

APIBasicJiraIssue: object

id: integer (int64)
key: string
self: URI

APIBasicJiraProject: object

id: integer (int64)
key: string
name: string
self: URI

APIBillingPeriod: object

additionalHours: integer (int64)
additionalHoursPrice: integer (int64)
apiBillingPeriodType: string , x ∈ { BUY , CHARGE , CANCEL }
createTime: string (date-time)
endBillingPeriod: string (date-time)
id: integer (int64)
lastPaymentDate: string (date-time)
mail: string
paid: boolean
paymentMethod: string , x ∈ { PAYPAL , BRAINTREE , INVOICE , PROMOTION }
plan: string
servicePrice: integer (int64)
startBillingPeriod: string (date-time)
subscriptionEnd: string (date-time)
subscriptionStart: string (date-time)
totalPrice: integer (int64)
userId: integer (int64)

APICluster: object

devices: APIAdminList«APIAdminDevice»
enabled: boolean
id: integer (int64)
name: string
state: string , x ∈ { OFFLINE , ONLINE }
stateChangeTime: string (date-time)
stateTime: string (date-time)
url: string

APIConnection: object

createTime: string (date-time)
deviceSessionId: integer (int64)
endTime: string (date-time)
host: string
id: integer (int64)
password: string
path: string
port: integer (int32)
type: string
url: string
urlSchema: string

APIDevice: object

aroSupported: boolean
creditsPrice: integer (int32)
displayName: string
enabled: boolean
frame100Url: string
frame160Url: string
frame400Url: string
frame80Url: string
frameExtraWidth: integer (int32)
id: integer (int64)
imageHeight: integer (int32)
imageLeft: integer (int32)
imagePrefix: string
imageTop: integer (int32)
imageWidth: integer (int32)
locked: boolean
online: boolean
osType: string , x ∈ { IOS , ANDROID , UNDEFINED }
softwareVersion: APISoftwareVersion
vncSupported: boolean

APIDeviceGroup: object

creditsPrice: integer (int64)
deviceCount: integer (int64)
displayName: string
id: integer (int64)
name: string
osType: string , x ∈ { IOS , ANDROID , UNDEFINED }
userId: integer (int64)

APIDeviceProperty: object

displayName: string
id: integer (int64)
name: string
propertyGroupId: integer (int64)
propertyGroupName: string

APIDeviceRun: object

createTime: string (date-time)
currentState: APIDeviceRunState
device: APIDevice
deviceName: string
deviceSerialId: string
deviceSessionId: integer (int64)
id: integer (int64)
interruptedByState: APIDeviceRunState
launchAppDuration: integer (int64)
runStatus: string , x ∈ { WAITING , RUNNING , EXCLUDED , WARNING , FAILED , SUCCEEDED }
softwareVersion: APISoftwareVersion
startTime: string (date-time)
testCaseAllNo: integer (int32)
testCaseFailedNo: integer (int32)
testCasePassedNo: integer (int32)
testCaseSkippedNo: integer (int32)
testCaseSuccessNo: integer (int32)

APIDeviceRunDataAvailability: object

buildLogs: boolean
deviceRunId: integer (int64)
id: integer (int64)
logs: boolean
performance: boolean
resultsDataZip: boolean
screenshots: boolean

APIDeviceRunState: object

deviceRunId: integer (int64)
deviceRunStateType: string , x ∈ { PREPARING , WAITING , DEVICE_WAITING , DEVICE_DOWNLOAD_TESTSESSION , DEVICE_UNINSTALLING_ALL , DEVICE_REBOOTING , DEVICE_WIFI_CHECKING , DEVICE_ADD_PERMISSIONS , DEVICE_REPACKAGING , DEVICE_TARGET_INSTALLING , DEVICE_TEST_INSTALLING , DEVICE_REMOTECONTROL_RUNNING , DEVICE_RUNNING , DEVICE_SDCARD_COPYING , DEVICE_TARGET_UNINSTALLING , DEVICE_UIAUTOMATOR_RUNNING , DEVICE_TEST_UNINSTALLING , RESULTS_WAITING , RESULTS_PROCESSING , PARSE_LOGCAT , ADB_SHELL_COMMAND }
failReason: string
finishTimeMS: integer (int64)
id: integer (int64)
retryTime: string (date-time)
startTimeMS: integer (int64)
status: string , x ∈ { STARTED , EXCLUDED , FAILED , SUCCEEDED , NOT_AVAILABLE }

APIDeviceSession: object

billable: boolean
createTime: string (date-time)
device: APIDevice
deviceRunId: integer (int64)
endTime: string (date-time)
excludeReason: string
id: integer (int64)
installTime: string (date-time)
launchAppDuration: integer (int64)
startTime: string (date-time)
state: string , x ∈ { WAITING , RUNNING , EXCLUDED , WARNING , FAILED , SUCCEEDED }
testCaseAllCount: integer (int32)
testCaseFailedCount: integer (int32)
testCasePassedCount: integer (int32)
testCaseSkippedCount: integer (int32)
testCaseSuccessCount: integer (int32)
timeLimit: integer (int64)
type: string , x ∈ { INTERACTIVE , AUTOMATIC }

APIDeviceSessionStep: object

deviceSessionId: integer (int64)
excludeReason: string
failReason: string
finishTimeMS: integer (int64)
id: integer (int64)
startTimeMS: integer (int64)
type: string , x ∈ { WAITING , PREPARING , UNINSTALL , INSTALL , RUNNING , SENDING_RESULTS , PROCESSING_RESULTS }

APIDeviceStatus: object

alarmOn: boolean
aslOn: boolean
batteryLevel: integer (int32)
bluetoothOn: boolean
clusterName: string
deviceId: integer (int64)
deviceName: string
deviceTime: integer (int64)
deviceTimeZone: string
emailAccount: string
externalStorage: integer (int64)
flashOn: boolean
id: integer (int64)
internalStorage: integer (int64)
internetAccess: boolean
locationServiceOn: boolean
mockLocationOn: boolean
monitoringOn: boolean
screenLocked: boolean
sdcardPresent: boolean
ssid: string
tdsVersion: string
testExecuting: boolean
tetheringOn: boolean
updateTime: string (date-time)

APIDeviceTimeCountSessionReportEntry: object

countDeviceSessions: integer (int64)
countTestRuns: integer (int64)
day: string (date-time)
deviceModelName: string
deviceTime: integer (int64)
id: integer (int64)
projectName: string
userEmail: string

APIDeviceTimeEntry: object

billableTime: integer (int64)
createTime: string (date-time)
deviceTime: integer (int64)
endTime: string (date-time)
freeTime: integer (int64)
id: integer (int64)
type: string , x ∈ { INTERACTIVE , AUTOMATIC }
userId: integer (int64)
userName: string

APIDeviceTimeStepTimeReportEntry: object

day: string (date-time)
deviceModelName: string
deviceTime: integer (int64)
id: integer (int64)
preparationTime: integer (int64)
projectName: string
userEmail: string
waitingTime: integer (int64)

APIEmailNotification: object

id: integer (int64)
message: string
subject: string
toggle: boolean
users: integer[]: integer (int64)

APIEvent: object

applicationType: string , x ∈ { RECORDER }
eventType: string , x ∈ { RECORDER_OPEN_WIZARD , RECORDER_RUN_IN_CLOUD , RECORDER_FINISH_WIZARD , RECORDER_RUN_APPCRAWLER }
id: integer (int64)

APIFile: object

id: integer (int64)
originalName: string
readableSize: string
uploadTime: string (date-time)

APIFiles: object

data: DataFile
id: integer (int64)

APIFileSet: object

createTime: string (date-time)
fileCount: integer (int64)
id: integer (int64)
name: string

APIJiraAccount: object

hasCertificate: boolean
id: integer (int64)
jiraUrl: string
userId: integer (int64)
username: string

APIJiraIssue: object

id: integer (int64)
key: string
self: URI

APIJiraIssueType: object

id: integer (int64)
name: string

APIJiraPriority: object

id: integer (int64)
name: string

APIJiraProject: object

description: string
id: integer (int64)
key: string
leadName: string
name: string
self: URI

APIJiraServerInfo: object

baseUri: URI
id: integer (int64)
version: string

APILabelGroup: object

displayName: string
hiddenByDefault: boolean
id: integer (int64)
name: string

APILicense: object

activateTime: string (date-time)
android: AndroidLicense
appium: AppiumLicense
autoRenew: boolean
calabash: CalabashLicense
expireTime: string (date-time)
expired: boolean
id: integer (int64)
inspector: InspectorLicense
ios: IOSLicense
privateInstance: boolean
recorder: RecorderLicense
remoteControl: RemoteControlLicense
selenium: SeleniumLicense
server: ServerLicense
status: string , x ∈ { ACTIVE , EXPIRED , INACTIVE }
userEmail: string
userId: integer (int64)

APIList«APIAccountService»: object

data: object[]: APIAccountService
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIBillingPeriod»: object

data: object[]: APIBillingPeriod
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIConnection»: object

data: object[]: APIConnection
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIDeviceGroup»: object

data: object[]: APIDeviceGroup
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIDeviceProperty»: object

data: object[]: APIDeviceProperty
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIDeviceRunState»: object

data: object[]: APIDeviceRunState
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIDeviceRun»: object

data: object[]: APIDeviceRun
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIDeviceSessionStep»: object

data: object[]: APIDeviceSessionStep
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIDeviceSession»: object

data: object[]: APIDeviceSession
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIDeviceTimeCountSessionReportEntry»: object

data: object[]: APIDeviceTimeCountSessionReportEntry
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIDeviceTimeStepTimeReportEntry»: object

data: object[]: APIDeviceTimeStepTimeReportEntry
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIDevice»: object

data: object[]: APIDevice
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIFileSet»: object

data: object[]: APIFileSet
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIJiraIssue»: object

data: object[]: APIJiraIssue
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APILabelGroup»: object

data: object[]: APILabelGroup
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APILicense»: object

data: object[]: APILicense
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APINotificationEmail»: object

data: object[]: APINotificationEmail
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIProjectJobConfig»: object

data: object[]: APIProjectJobConfig
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIProjectSharing»: object

data: object[]: APIProjectSharing
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIProject»: object

data: object[]: APIProject
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIRole»: object

data: object[]: APIRole
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIScreenshot»: object

data: object[]: APIScreenshot
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIService»: object

data: object[]: APIService
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APITag»: object

data: object[]: APITag
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APITestCaseRunStep»: object

data: object[]: APITestCaseRunStep
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APITestCaseRun»: object

data: object[]: APITestCaseRun
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APITestRunExtended»: object

data: object[]: APITestRunExtended
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APITestRunParameter»: object

data: object[]: APITestRunParameter
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APITestRun»: object

data: object[]: APITestRun
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIUserFileTag»: object

data: object[]: APIUserFileTag
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIUserFile»: object

data: object[]: APIUserFile
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APIList«APIUser»: object

data: object[]: APIUser
empty: boolean
id: integer (int64)
limit: integer (int32)
next: string
offset: integer (int32)
previous: string
search: string
sort: string
total: integer (int32)

APINotificationEmail: object

email: string
id: integer (int64)
project: APIProject
type: string , x ∈ { ALWAYS , ON_FAILURE }

APIProject: object

archiveTime: string (date-time)
archivingItemCount: integer (int32)
archivingStrategy: string , x ∈ { NEVER , DAYS , RUNS }
archivingStrategyDisplayValue: string
common: boolean
createTime: string (date-time)
description: string
id: integer (int64)
name: string
sharedByEmail: string
sharedById: integer (int64)
type: string , x ∈ { ANDROID , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }

APIProjectJobConfig: object

content: string
global: boolean
id: integer (int64)
lastModificationTime: string (date-time)
lastModifiedBy: string
projectId: integer (int64)
projectName: string
type: string , x ∈ { DEFAULT , INSTATEST , INTERACTIVE , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
version: integer (int32)

APIProjectSharing: object

id: integer (int64)
userEmail: string
userId: integer (int64)

APIProperty: object

description: string
fromTime: string (date-time)
id: integer (int64)
name: string
toTime: string (date-time)
updateTime: string (date-time)
updatedByDisplayName: string
updatedById: integer (int64)
value: string

APIRole: object

addedByEmail: string
expireTime: string (date-time)
id: integer (int64)
name: string

APIScreenshot: object

fail: boolean
id: integer (int64)
originalName: string
takeTimestamp: integer (int64)
type: string , x ∈ { LANDSCAPE , PORTRAIT }

APIService: object

activateTime: string (date-time)
archiveTime: string (date-time)
autoRenew: boolean
braintreeId: string
centPrice: integer (int32)
customPlan: boolean
description: string
id: integer (int64)
includedHours: integer (int32)
name: string
pricePerHour: integer (int32)
priceString: string
unit: string , x ∈ { MONTH , DAY , YEAR , HOUR , RUN , PROJECT }
unitCount: integer (int32)

APIServicePaymentStatus: object

accountService: APIAccountService
message: string
redirectionPostData: string
redirectionUrl: string
status: string , x ∈ { SUCCEEDED , FAILED , REDIRECTED }

APISession: object

email: string
headers: string
id: integer (int64)
ip: string
loginTime: string (date-time)
logoutTime: string (date-time)
sessionId: string
userId: integer (int64)

APISoftwareVersion: object

apiLevel: integer (int32)
id: integer (int64)
releaseVersion: string

APITag: object

id: integer (int64)
name: string

APITestCaseRun: object

className: string
createTime: string (date-time)
duration: number (double)
errorMessage: string
id: integer (int64)
methodName: string
result: string , x ∈ { PASSED , FAILED , SKIPPED , NOT_AVAILABLE }
stacktrace: string
steps: APIList«APITestCaseRunStep»
suiteName: string

APITestCaseRunStep: object

description: string
duration: integer (int64)
errorMessage: string
fromActivity: string
id: integer (int64)
screenshots: APIList«APIScreenshot»
type: string , x ∈ { ASSERTION , CLICK , CONFIG , DRAG , INPUT , NAVIGATION , OTHER , SCROLL , UTIL , WAIT }

APITestRun: object

createTime: string (date-time)
displayName: string
executionRatio: number (float)
id: integer (int64)
logsFileId: integer (int64)
number: integer (int32)
projectId: integer (int64)
screenshotsFileId: integer (int64)
startedByDisplayName: string
state: string , x ∈ { WAITING , RUNNING , FINISHED }
successRatio: number (float)

APITestRunConfig: object

appRequired: boolean
applicationPassword: string
applicationUsername: string
autoScreenshots: boolean
checkApp: boolean
creditsPrice: integer (int32)
deviceLanguageCode: string
gamebenchEnabled: boolean
hookURL: string
id: integer (int64)
instrumentationRunner: string
launchApp: boolean
limitationType: string , x ∈ { PACKAGE , CLASS }
limitationValue: string
mode: string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
projectId: integer (int64)
runAvailable: boolean
scheduler: string , x ∈ { PARALLEL , SERIAL , SINGLE }
screenshotDir: string
timeout: integer (int64)
uiAutomatorTestClasses: string
usedDeviceGroupId: integer (int64)
withAnnotation: string
withoutAnnotation: string

APITestRunDataAvailability: object

application: boolean
deviceRunDataAvailabilities: object[]: APIDeviceRunDataAvailability
id: integer (int64)
test: boolean
testRunId: integer (int64)

APITestRunExtended: object

createTime: string (date-time)
deviceCount: integer (int32)
displayName: string
executionRatio: number (float)
files: APIFiles
id: integer (int64)
logsFileId: integer (int64)
number: integer (int32)
projectId: integer (int64)
screenshotsFileId: integer (int64)
startedByDisplayName: string
state: string , x ∈ { WAITING , RUNNING , FINISHED }
successRatio: number (float)
tags: object[]: APITag

APITestRunParameter: object

id: integer (int64)
key: string
value: string

APIUser: object

accountId: integer (int64)
activeServiceId: integer (int64)
address: string
apiKey: string
city: string
code: string
country: string
createTime: string (date-time)
email: string
emailNotification: string , x ∈ { ALWAYS , NEVER , ON_FAILURE }
enabled: boolean
id: integer (int64)
isMainUser: boolean
lastLoginTime: string (date-time)
mainUserEmail: string
mainUserId: integer (int64)
name: string
organization: string
phone: string
roles: object[]: APIRole
state: string
status: string , x ∈ { INACTIVE , DISABLED , ENABLED }
timeZone: string
vatID: string

APIUserDeviceTime: object

automaticDeviceTime: integer (int64)
deviceTimeEntries: object[]: APIDeviceTimeEntry
freeDeviceTime: integer (int64)
id: integer (int64)
inspectorDeviceTime: integer (int64)
periodEnd: integer (int64)
periodStart: integer (int64)
totalDeviceTime: integer (int64)

APIUserFile: object

createTime: string (date-time)
fileProperties: object[]: APIUserFileProperty
id: integer (int64)
name: string
size: integer (int64)
state: string , x ∈ { PREPARING , READY }

APIUserFileProperty: object

id: integer (int64)
key: string
value: string

APIUserFileTag: object

id: integer (int64)
name: string

AppiumLicense: object

enabled: boolean

BillingPeriod: object

additionalHoursPaymentDate: LocalDateTime
additionalHoursPrice: integer (int64)
additionalTime: integer (int64)
billingPeriodEnd: LocalDateTime
billingPeriodStart: LocalDateTime
createTime: LocalDateTime
id: integer (int64)
paymentDate: LocalDateTime
paymentMethod: string , x ∈ { PAYPAL , BRAINTREE , INVOICE , PROMOTION }
servicePrice: integer (int64)
subscriptionEnd: LocalDateTime
subscriptionStart: LocalDateTime
totalPrice: integer (int64)

CalabashLicense: object

enabled: boolean

Chronology: object

zone: DateTimeZone

CTSLicense: object

enabled: boolean

DataFile: object

id: integer (int64)
originalName: string
readableSize: string
uploadTime: string (date-time)

DateTimeField: object

durationField: DurationField
leapDurationField: DurationField
lenient: boolean
maximumValue: integer (int32)
minimumValue: integer (int32)
name: string
rangeDurationField: DurationField
supported: boolean
type: DateTimeFieldType

DateTimeFieldType: object

durationType: DurationFieldType
name: string
rangeDurationType: DurationFieldType

DateTimeZone: object

fixed: boolean
id: string

DurationField: object

name: string
precise: boolean
supported: boolean
type: DurationFieldType
unitMillis: integer (int64)

DurationFieldType: object

name: string

InspectorLicense: object

enabled: boolean

IOSLicense: object

deviceLimit: integer (int32)
deviceLimited: boolean
enabled: boolean
projectLimit: integer (int32)
projectLimited: boolean

LocalDateTime: object

centuryOfEra: integer (int32)
chronology: Chronology
dayOfMonth: integer (int32)
dayOfWeek: integer (int32)
dayOfYear: integer (int32)
era: integer (int32)
fieldTypes: object[]: DateTimeFieldType
fields: object[]: DateTimeField
hourOfDay: integer (int32)
millisOfDay: integer (int32)
millisOfSecond: integer (int32)
minuteOfHour: integer (int32)
monthOfYear: integer (int32)
secondOfMinute: integer (int32)
values: integer[]: integer (int32)
weekOfWeekyear: integer (int32)
weekyear: integer (int32)
year: integer (int32)
yearOfCentury: integer (int32)
yearOfEra: integer (int32)

RecorderLicense: object

enabled: boolean
limit: integer (int32)
limited: boolean

RemoteControlLicense: object

enabled: boolean

Role: object

accountRoles: object[]: AccountRole
id: integer (int64)
name: string
serviceRoles: object[]: ServiceRole

SeleniumLicense: object

enabled: boolean

ServerLicense: object

androidEnabled: boolean
enabled: boolean
iosEnabled: boolean

Service: object

accountServices: object[]: AccountService
activateTime: string (date-time)
active: boolean
archiveTime: string (date-time)
archived: boolean
autoRenew: boolean
braintreePlanId: string
createTime: string (date-time)
customPlan: boolean
description: string
id: integer (int64)
inactive: boolean
includedHours: integer (int32)
name: string
price: integer (int32)
pricePerHour: integer (int32)
roles: object[]: Role
serviceRoles: object[]: ServiceRole
unit: string , x ∈ { MONTH , DAY , YEAR , HOUR , RUN , PROJECT }
unitCount: integer (int32)

ServiceRole: object

createTime: string (date-time)
id: integer (int64)
service: Service
serviceCount: integer (int32)
unit: string , x ∈ { MONTH , DAY , YEAR , HOUR , RUN , PROJECT }
unitCount: integer (int32)

UIAutomatorLicense: object

enabled: boolean

URI: object

absolute: boolean
authority: string
fragment: string
host: string
opaque: boolean
path: string
port: integer (int32)
query: string
rawAuthority: string
rawFragment: string
rawPath: string
rawQuery: string
rawSchemeSpecificPart: string
rawUserInfo: string
scheme: string
schemeSpecificPart: string
userInfo: string

User: object

Heard from: string
Organization role: string
Status: string
account: Account
accountRoles: object[]: AccountRole
active: boolean
address: string
apiKey: string
availableHearFromValues: string[]: string
availableOrganizationRoleValues: string[]: string
billing: boolean
city: string
code: string
country: string
countryDisplayname: string
createTime: string (date-time)
displayLocaleCountry: string
displayname: string
email: string
hearFrom: string , x ∈ { COWORKER , EMAIL_CAMPAIGN , EVENT , ONLINE_COMMUNITY , SOCIAL_NETWORK , WEB_SEARCH , OTHER }
id: integer (int64)
lastAccountChange: string (date-time)
name: string
organization: string
organizationRole: string , x ∈ { CEO_OR_OWNER , VP , MANAGER , INDIVIDUAL , QUALITY_ASSURANCE , DEVELOPER , MARKETING , CONSULTANT , OTHER }
password: string
phone: string
recoveryKey: string
registrationIP: string
state: string
timeZone: string
vatRate: integer (int32)